Airmeet · AsyncAPI Specification

Airmeet Webhooks

Version 1.0

Airmeet delivers event engagement and lifecycle notifications via webhooks. Subscribers register a destination URL against a trigger via POST /platform-integration/v1/webhook-register (headers x-access-key / x-secret-key). Event-specific triggers accept an airmeetId query parameter on the registered endpoint; some support a sessionId parameter. Airmeet POSTs a JSON payload to the registered URL when the trigger fires.

View Spec View on GitHub CompanyCloud SaasEventsVirtual EventsWebinarsEvent ManagementCommunityWebhooksAsyncAPIWebhooksEvents

Channels

trigger.airmeet.created
subscribe onAirmeetCreated
A new Airmeet was created.
trigger.airmeet.started
subscribe onAirmeetStarted
An Airmeet started.
trigger.airmeet.finished
subscribe onAirmeetFinished
An Airmeet finished.
trigger.airmeet.reminder
subscribe onAirmeetReminder
Event start reminder.
trigger.airmeet.attendee.added
subscribe onAttendeeAdded
A new registration was added.
trigger.airmeet.registrant.added
subscribe onRegistrantAdded
Registration for a specific event.
trigger.airmeet.attendee.joined
subscribe onAttendeeJoinedEvent
An attendee joined the event.
trigger.session.attendee.joined
subscribe onAttendeeJoinedSession
An attendee joined a session.
trigger.airmeet.polls
subscribe onPollAnswered
An attendee answered a poll.
trigger.airmeet.questions
subscribe onQuestionAsked
An attendee asked a question.
trigger.attendee.booth.joined
subscribe onBoothVisited
An attendee visited a booth.
trigger.attendee.clicked_cta
subscribe onCtaClicked
An attendee clicked a CTA.
trigger.attendee.entered_airmeet
subscribe onEnteredEvent
An attendee entered the event.
trigger.attendee.engagement_score
subscribe onEngagementScore
Attendee engagement score data.
trigger.leaderboard.scoreboard
subscribe onLeaderboardScore
Leaderboard score data.
trigger.attendee.joined_stage
subscribe onJoinedStage
An attendee joined the stage.
trigger.attendee.joined_booth
subscribe onJoinedBooth
An attendee joined a booth.
trigger.attendee.joined_table
subscribe onJoinedTable
An attendee joined a table.
trigger.attendee.joined_session
subscribe onJoinedSession
An attendee joined a session.
trigger.attendee.opened_resource
subscribe onResourceOpened
An attendee viewed or downloaded a resource.
trigger.attendee.ondemand_session_attendance
subscribe onReplayViewed
An attendee viewed a session replay.

Messages

✉
WebhookEvent
Airmeet webhook event

AsyncAPI Specification

Raw ↑ 
asyncapi: 2.6.0
info:
  title: Airmeet Webhooks
  version: '1.0'
  description: >-
    Airmeet delivers event engagement and lifecycle notifications via webhooks.
    Subscribers register a destination URL against a trigger via
    POST /platform-integration/v1/webhook-register (headers x-access-key /
    x-secret-key). Event-specific triggers accept an airmeetId query parameter
    on the registered endpoint; some support a sessionId parameter. Airmeet POSTs
    a JSON payload to the registered URL when the trigger fires.
  externalDocs:
    description: Airmeet Webhooks documentation
    url: https://help.airmeet.com/support/solutions/articles/82000878498-airmeet-webhooks
defaultContentType: application/json
channels:
  trigger.airmeet.created:
    subscribe:
      operationId: onAirmeetCreated
      summary: A new Airmeet was created.
      message: { $ref: '#/components/messages/WebhookEvent' }
  trigger.airmeet.started:
    subscribe:
      operationId: onAirmeetStarted
      summary: An Airmeet started.
      message: { $ref: '#/components/messages/WebhookEvent' }
  trigger.airmeet.finished:
    subscribe:
      operationId: onAirmeetFinished
      summary: An Airmeet finished.
      message: { $ref: '#/components/messages/WebhookEvent' }
  trigger.airmeet.reminder:
    subscribe:
      operationId: onAirmeetReminder
      summary: Event start reminder.
      message: { $ref: '#/components/messages/WebhookEvent' }
  trigger.airmeet.attendee.added:
    subscribe:
      operationId: onAttendeeAdded
      summary: A new registration was added.
      message: { $ref: '#/components/messages/WebhookEvent' }
  trigger.airmeet.registrant.added:
    subscribe:
      operationId: onRegistrantAdded
      summary: Registration for a specific event.
      message: { $ref: '#/components/messages/WebhookEvent' }
  trigger.airmeet.attendee.joined:
    subscribe:
      operationId: onAttendeeJoinedEvent
      summary: An attendee joined the event.
      message: { $ref: '#/components/messages/WebhookEvent' }
  trigger.session.attendee.joined:
    subscribe:
      operationId: onAttendeeJoinedSession
      summary: An attendee joined a session.
      message: { $ref: '#/components/messages/WebhookEvent' }
  trigger.airmeet.polls:
    subscribe:
      operationId: onPollAnswered
      summary: An attendee answered a poll.
      message: { $ref: '#/components/messages/WebhookEvent' }
  trigger.airmeet.questions:
    subscribe:
      operationId: onQuestionAsked
      summary: An attendee asked a question.
      message: { $ref: '#/components/messages/WebhookEvent' }
  trigger.attendee.booth.joined:
    subscribe:
      operationId: onBoothVisited
      summary: An attendee visited a booth.
      message: { $ref: '#/components/messages/WebhookEvent' }
  trigger.attendee.clicked_cta:
    subscribe:
      operationId: onCtaClicked
      summary: An attendee clicked a CTA.
      message: { $ref: '#/components/messages/WebhookEvent' }
  trigger.attendee.entered_airmeet:
    subscribe:
      operationId: onEnteredEvent
      summary: An attendee entered the event.
      message: { $ref: '#/components/messages/WebhookEvent' }
  trigger.attendee.engagement_score:
    subscribe:
      operationId: onEngagementScore
      summary: Attendee engagement score data.
      message: { $ref: '#/components/messages/WebhookEvent' }
  trigger.leaderboard.scoreboard:
    subscribe:
      operationId: onLeaderboardScore
      summary: Leaderboard score data.
      message: { $ref: '#/components/messages/WebhookEvent' }
  trigger.attendee.joined_stage:
    subscribe:
      operationId: onJoinedStage
      summary: An attendee joined the stage.
      message: { $ref: '#/components/messages/WebhookEvent' }
  trigger.attendee.joined_booth:
    subscribe:
      operationId: onJoinedBooth
      summary: An attendee joined a booth.
      message: { $ref: '#/components/messages/WebhookEvent' }
  trigger.attendee.joined_table:
    subscribe:
      operationId: onJoinedTable
      summary: An attendee joined a table.
      message: { $ref: '#/components/messages/WebhookEvent' }
  trigger.attendee.joined_session:
    subscribe:
      operationId: onJoinedSession
      summary: An attendee joined a session.
      message: { $ref: '#/components/messages/WebhookEvent' }
  trigger.attendee.opened_resource:
    subscribe:
      operationId: onResourceOpened
      summary: An attendee viewed or downloaded a resource.
      message: { $ref: '#/components/messages/WebhookEvent' }
  trigger.attendee.ondemand_session_attendance:
    subscribe:
      operationId: onReplayViewed
      summary: An attendee viewed a session replay.
      message: { $ref: '#/components/messages/WebhookEvent' }
components:
  messages:
    WebhookEvent:
      name: WebhookEvent
      title: Airmeet webhook event
      contentType: application/json
      payload:
        type: object
        properties:
          trigger: { type: string, description: The trigger/event name. }
          airmeetId: { type: string }
          sessionId: { type: string }
          data: { type: object, description: Trigger-specific event data. }