Airmeet Webhooks v1.0

Modified on Sat, 30 Sep 2023 at 04:08 PM

TABLE OF CONTENTS

1) Why should I use Webhooks?

2) How to Register a webhook with Airmeet / How to subscribe to a Trigger?

3) How to De-register a webhook / How to unsubscribe from a trigger?

4) How to get sample payload data for each webhook?

5) Get x-access-key & x-secret-key

API endpoints:

Default region (Mumbai): https://api-gateway.airmeet.com/prod

EU region: https://api-gateway-prod.eu.airmeet.com/prod

US region: https://api-gateway-prod.us.airmeet.com/prod

Community dashboard: https://www.airmeet.com/ (use this to get a key pair issued).

1) Why should I use Webhooks?

Webhooks provide an easy way for Airmeet to send real-time data to an application of your choice. You can use these to integrate with your workflows to automate campaigns and alerts.

Airmeet has webhooks for the following use cases -

Available Triggers	Trigger Description	Trigger Id (TriggerMetaInfoId)
New Airmeet Created	Triggered when a new Airmeet is created for a community	trigger.airmeet.created
Airmeet Started	Triggered when the Airmeet is scheduled to start	trigger.airmeet.started
Airmeet Finished	Triggered when the Airmeet is scheduled to finish. This does not end the event, but the organizer can use this as a reminder to end the event.	trigger.airmeet.finished
Event Start Reminder	Triggered 4 hours before an Airmeet is scheduled to start	trigger.airmeet.reminder
Recordings Available	Triggered when recordings for an Airmeet are available	trigger.airmeet.recording.available
New Registration Added	Triggered when a new registration is completed for any Airmeet in your community	trigger.airmeet.attendee.added
New Registration Added for a specific event	Triggered when a new registration is completed for a specific Airmeet event in your community	trigger.airmeet.registrant.added See Note 1 below
Attendee Joined an Airmeet	When an attendee joins an Airmeet. All data for this trigger is sent post-event completion	trigger.airmeet.attendee.joined See Note 1 below
Attendee Joined a Session on Airmeet	When an attendee joins a Session on Airmeet. All data for this trigger is sent post-session completion	trigger.session.attendee.joined See Note 1 below
Attendee Answered a Poll on Airmeet	When an attendee answers a Poll on Airmeet. All data for this trigger is sent post-session completion	trigger.airmeet.polls See Note 1 below
Registration UTM for a specific event	Triggered when a new registration is added via UTM.	trigger.airmeet.attendee.utms See Note 1 below

Note: The data for UTM parameters will be synced within 90 mins of API call.

Use this endpoint to register a webhook

Request Endpoint: /platform-integration/v1/webhook-register

Request Method: POST

Request Headers:

Content-Type: application/json
Accept: application/json
x-access-key
x-secret-key

Request Payload:

{

 

   "name": "Trigger Label",                // String Type

 

   "description": "Trigger Description",   // String Type

 

   "triggerMetaInfoId": "Trigger Id",      // String Type

 

   "url": "Webhook Url"                    // String Type



   "platformName": "Company Name"         // String Type

}

Field	Description	Model	Required
name	Name for your webhook	string	Yes See Note 2
description	Description for your webhook	string	No
triggerMetaInfoId	The trigger type	string Select from one of the available triggers ids mentioned earlier	Yes
url	Webhook url	url	Yes
platformName	Company Name	string	Yes

Note 1 -

For Trigger Id trigger.airmeet.registrant.added, trigger.airmeet.attendee.joined, trigger.session.attendee.joined and trigger.airmeet.polls the webhook request endpoint URL has an additional query parameter 'airmeetId'.

Sample format: /platform-integration/v1/webhook-register?airmeetId=<airmeetid>

Where airmeetid is the uuid for an Airmeet event.

For Trigger Id trigger.session.attendee.joined a second query parameter 'sessionId' is also available :

/platform-integration/v1/webhook-register?airmeetId=<airmeetid>&sessionId=<sessionid> ,

Where sessionid is the uuid for the session in that Airmeet event.

Note 2 -

The name field is currently tightly linked to the triggerMetaInfoId. Please use the correct name field, along with the triggerMetaInfoId to ensure that the webhooks are registered correctly.

triggerMetaInfoId	name	include airmeetId parameter*	include sessionId parameter*
trigger.airmeet.created	AIRMEET_CREATED
trigger.airmeet.attendee.added	AIRMEET_CREATED
trigger.airmeet.started	AIRMEET_STARTED
trigger.airmeet.finished	AIRMEET_FINISHED
trigger.airmeet.reminder	AIRMEET_REMINDER
trigger.airmeet.recording.available	AIRMEET_STARTED
trigger.airmeet.registrant.added	REGISTRANT_ADDED	Yes*
trigger.airmeet.attendee.joined	ATTENDEE_JOINED_EVENT	Yes*
trigger.session.attendee.joined	ATTENDEE_JOINED_SESSION	Yes*	Yes*
trigger.airmeet.polls	EVENT_POLLS	Yes*
trigger.airmeet.questions	EVENT_QUESTIONS	Yes*
trigger.attendee.booth.joined	BOOTH_ATTENDEE	Yes*
trigger.airmeet.attendee.utms	REGISTRATION_UTMS	Yes*

Response Headers:

Content-Type: application/json

Response Payload:

{

 

 "statusCode": "2000",                              // String Type

 

 "statusMessage": "SUCCESS",                        // String Type

 

 "payload": {

 

   "id": "Webhook Registration Id",

 

   "triggerMetaInfoId": "TriggerId",                // String Type

 

   "name": "Trigger Label",                         // String Type

 

   "description": "Trigger Description",            // String Type

 

   "url": "Webhook Url",                            // String Type

 

   "isActive": true,                                // Boolean Type

 

   "createdAt": "2020-08-04T06:38:51.106+00:00",    // DateTime Type

 

   "updatedAt": "2020-08-04T06:38:51.106+00:00",    // DateTime Type

 

   "updatedBy": "Updated By Person",                // String Type

 

   "createdBy": "Created By Person"                 // String Type

 

 }

 

}

3) How to De-register a webhook / How to unsubscribe from a trigger?

Use this endpoint to de-register a webhook

Request Endpoint: /platform-integration/v1/webhook-deregister

Request Method: POST

Request Headers:

Content-Type: application/json
Accept: application/json
x-access-key
x-secret-key

Request Payload:

{

 

   "id": "Webhook Registration Id",        // String Type

 

   "triggerMetaInfoId": "Trigger Id",      // String Type

 

   "url": "Webhook Url"                    // String Type

 

}

Field	Description	Model	Required
id	Webhook Registration Id	string	Yes
triggerMetaInfoId	The trigger type	string Select from one of the available triggers ids mentioned earlier	Yes
url	Webhook url	url	Yes