curl --request GET \
--url https://api.smokeball.com/webhooks \
--header 'Authorization: <api-key>' \
--header 'x-api-key: <api-key>'{
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "GET",
"self": {
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "GET"
},
"value": [
{
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "GET",
"self": {
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "GET"
},
"accountId": "da4e7fd1-5394-4ca9-b1c6-e18c4e2bf262",
"name": "Listen to matter and contact changes",
"eventTypes": [
"matter.updated",
"contact.created"
],
"eventNotificationUrl": "http://yourdomain.com/notify",
"createdDateUtc": "2022-04-23T14:00:00Z",
"updatedDateUtc": "2022-04-23T14:00:00Z",
"lastUpdated": 637847425252027400
}
],
"offset": 123,
"limit": 123,
"size": 123,
"first": {
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "GET"
},
"previous": {
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "GET"
},
"next": {
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "GET"
},
"last": {
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "GET"
}
}Returns existing webhook subscriptions.
curl --request GET \
--url https://api.smokeball.com/webhooks \
--header 'Authorization: <api-key>' \
--header 'x-api-key: <api-key>'{
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "GET",
"self": {
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "GET"
},
"value": [
{
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "GET",
"self": {
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "GET"
},
"accountId": "da4e7fd1-5394-4ca9-b1c6-e18c4e2bf262",
"name": "Listen to matter and contact changes",
"eventTypes": [
"matter.updated",
"contact.created"
],
"eventNotificationUrl": "http://yourdomain.com/notify",
"createdDateUtc": "2022-04-23T14:00:00Z",
"updatedDateUtc": "2022-04-23T14:00:00Z",
"lastUpdated": 637847425252027400
}
],
"offset": 123,
"limit": 123,
"size": 123,
"first": {
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "GET"
},
"previous": {
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "GET"
},
"next": {
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "GET"
},
"last": {
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "GET"
}
}0 <= x <= 21474836471 <= x <= 500When request is successful. Returns existing webhook subscriptions.
Show child attributes
Unique identifier of the associated account.
"da4e7fd1-5394-4ca9-b1c6-e18c4e2bf262"
Name or description of the subscription.
"Listen to matter and contact changes"
The event types that the webhook subscription is subscribed to.
["matter.updated", "contact.created"]The uri to notify when an event has occurred.
"http://yourdomain.com/notify"
The webhook subscription creation date.
"2022-04-23T14:00:00Z"
The webhook subscription last updated date.
"2022-04-23T14:00:00Z"
Last updated timestamp
637847425252027400