Events
GET/v1/webhooks/subscriptions/{id}/eventsGET /v1/webhooks/subscriptions/{id}/events
Code samples
cURL
# You can also use wget
curl -X GET /v1/webhooks/subscriptions/{id}/events \
-H 'Accept: text/plain' \
-H 'x-api-key: API_KEY'
GET /v1/webhooks/subscriptions/\{id\}/events
Gets all events for a specific webhook subscription.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The subscription ID. |
| select | query | string | false | none |
| filter | query | string | false | none |
| sort | query | string | false | none |
| include | query | string | false | none |
| take | query | integer(int32) | false | none |
| skip | query | integer(int32) | false | none |
Example responses
200 Response
{"events":[{"id":0,"webhookSubscriptionId":0,"eventType":"string","payload":"string","statusCode":0,"response":"string","errorMessage":"string","isSuccess":true,"retryCount":0,"sentAt":"2019-08-24T14:15:22Z","nextRetryAt":"2019-08-24T14:15:22Z","createdAt":"2019-08-24T14:15:22Z"}],"totalEventsCount":0,"success":true,"message":"string"}{
"events": [
{
"id": 0,
"webhookSubscriptionId": 0,
"eventType": "string",
"payload": "string",
"statusCode": 0,
"response": "string",
"errorMessage": "string",
"isSuccess": true,
"retryCount": 0,
"sentAt": "2019-08-24T14:15:22Z",
"nextRetryAt": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z"
}
],
"totalEventsCount": 0,
"success": true,
"message": "string"
}Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | Management.GetWebhookEventsResponse |
Authentication: API key (x-api-key).
DELETE/v1/webhooks/subscriptions/{id}/events/{eventId}DELETE /v1/webhooks/subscriptions/{id}/events/{eventId}
Code samples
cURL
# You can also use wget
curl -X DELETE /v1/webhooks/subscriptions/{id}/events/{eventId} \
-H 'Accept: text/plain' \
-H 'x-api-key: API_KEY'
DELETE /v1/webhooks/subscriptions/\{id\}/events/\{eventId\}
Deletes a webhook event.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | The subscription ID. |
| eventId | path | integer(int32) | true | The event ID. |
Example responses
200 Response
{"success":true,"message":"string"}{
"success": true,
"message": "string"
}Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | Management.DeleteWebhookEventResponse |
Authentication: API key (x-api-key).
Last updated on