Webhooks
Overview
When triggered, webhooks send event data to an external server. Triggering events include creation, modification, and removal of users, tasks, or surveys.
Webhook API tools allow you to configure webhooks and view logs that include sent event data and server responses.
Get All Webhooks
Returns an array of all webhooks saved within the company.
GET /webhook/subscriptionEndpoint URL
https://www.cotalker.com/api/v3/webhook/subscription
Headers
| Header | Description | Required | Values |
|---|---|---|---|
| Authorization | Sends your access token to make an API request. Click here to see how to obtain an access token. | Required | Bearer $ACCESS_TOKEN |
Request Sample
curl --location --request GET 'https://www.cotalker.com/api/v3/webhook/subscription' \
--header 'Authorization: Bearer $ACCESS_TOKEN'
Response Sample
Responses follow the COTWebhook data model.
Get Webhook by Id
Returns the indicated webhook by its id.
GET /webhook/subscription/{id}Endpoint URL
https://www.cotalker.com/api/v3/webhook/subscription/{id}
Path Parameters
| Parameter | Description | Type | Required | Notes |
|---|---|---|---|---|
| id | The ObjectId of the webhook that is to be returned. | ObjectId<COTWebhook> | Required |
Headers
| Header | Description | Required | Values |
|---|---|---|---|
| Authorization | Sends your access token to make an API request. Click here to see how to obtain an access token. | Required | Bearer $ACCESS_TOKEN |
Request Sample
curl --location --request GET 'https://dev.cotalker.com/api/v3/webhook/subscription/6273f7e124c886d54e60eefe' \
--header 'Authorization: Bearer $ACCESS_TOKEN'
Response Sample
The response follows the COTWebhook data model.
Get Webhook Logs
Returns an array of the event logs generated by a webhook.
GET /webhook/subscription/logs/{id}Endpoint URL
https://www.cotalker.com/api/v3/webhook/subscription/logs/{id}
Path Parameters
| Parameter | Description | Type | Required | Notes |
|---|---|---|---|---|
| id | The ObjectId of the webhook that contains the event logs to be returned. | ObjectId<COTWebhook> | Required |
Headers
| Header | Description | Required | Values |
|---|---|---|---|
| Authorization | Sends your access token to make an API request. Click here to see how to obtain an access token. | Required | Bearer $ACCESS_TOKEN |
Request Sample
curl --location --request GET 'https://dev.cotalker.com/api/v3/webhook/subscription/logs/62685990d918fb5557f9f992' \
--header 'Authorization: Bearer $ACCESS_TOKEN'
Response Sample
The response follows the COTWebhookLog data model.