TABLE OF CONTENTS
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 kindly follow the following steps:
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 -
2) How to Register a webhook with Airmeet / How to subscribe to a Trigger?
Use this endpoint to register a webhook
Request Endpoint: https://api-gateway.airmeet.com/prod/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 }
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: https://api-gateway.airmeet.com/prod/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 :
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.
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: https://api-gateway.airmeet.com/prod/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 }
Response Payload:
{
"statusCode": "2000", // String Type
"statusMessage": "SUCCESS", // String Type
}
4) How to get sample payload data for each webhook?
Use this endpoint to get a sample payload for the different triggers
Request Endpoint: https://api-gateway.airmeet.com/prod/platform-integration/v1/sample-payload?triggerMetaInfoId=<triggerid>
Request Method: GET
Request Headers:
Accept: application/json
X-access-key
x-secret-key
Request Params:
{ "triggerMetaInfoId": "Trigger Id" // String Type }
Response Headers:
Content-Type: application/json
5) Get x-access-key & x-secret-key kindly follow the following steps:
Step 1: Sign in to your airmeet account ( https://www.airmeet.com/signup )
Step 2: Click on the "Integrations" tab and select the "API Access Key" section.
Step 3: Click on "Generate access key" and provide a name/label to your key (can be anything that can be remembered later)
Step 4: After providing your label name 'X-Airmeet-Access-Key' with 'X-Airmeet-Secret-Key' would be generated, which can be used in API integration.
Access Key = X-Airmeet-Access-Key
Secret Key = X-Airmeet-Secret-Key
Need more help? Contact support@airmeet.com or visit our 24*7 Support Lounge.
Want to brainstorm and connect with other Airmeet Users and Event Professionals from around the world? Fill in the form to Join our community on Slack.