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 All Active Webhooks
- 6. 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 -
2. How to Register a webhook with Airmeet / How to subscribe to a Trigger?
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
}
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 triggerMetaInfoId field to ensure that the webhooks are registered correctly
name* : The name can be any text of your preference.
Response Headers:
Content-Type: application/json
Response Payload:
{
"statusCode": "200", // 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
}
Response Payload:
{
"statusCode": "200", // 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: /platform-integration/v1/sample-payload?triggerMetaInfoId=<triggerMetaInfoId>
Request Method: GET
Request Headers:
Accept: application/json
X-access-key
x-secret-key
Response Headers:
Content-Type: application/json
5. Get all Active Webhooks
Endpoint:
GET /platform-integration/v1/webhook-list?airmeetId=<airmeet_id> or
GET /platform-integration/v1/webhook-list?sessionId=<session_id>
This API gives a list of all webhooks associated with the event or the session.
Headers:
X-Airmeet-Access-Token: airmeet_access_token
Response:
200 OK -
{
"webhookDTOList": [
{
"id": "webhook id,
"triggerMetaInfoId": "trigger.airmeet.attendee.registered",
"name": "webhook name",
"description": null,
"url": "dummy url",
"platformName": "platform name",
"isActive": true,
"metaData": "",
"createdAt": "2024-04-04T11:26:35.000+00:00",
"updatedAt": "2024-04-04T11:26:35.000+00:00",
"createdBy": "foi_2344n",
"updatedBy": null
} ]
}400 Bad Request - in case the passed token is bad
401 Unauthorized - in case the passed token does not have permission for the passed airmeet_id
404 Not Found - in case the supplied airmeet_id param is invalid
412 Precondition Failed - the passed access token has expired
500 Internal Server Error - generic server error
6. 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 [email protected] or visit our 24*7 Support Lounge.
Was this article helpful?
That’s Great!
Thank you for your feedback
Sorry! We couldn't be helpful
Thank you for your feedback
Feedback sent
We appreciate your effort and will try to fix the article