POST - Subscription
(Please note that updates to webhook subscriptions can take up to 15 minutes to take effect.)
Below are the required parameters to POST a subscription:
Name | Description |
---|---|
EventType | The type of event you wish to have generated to the callback URL. Options can be found here: Webhook Event Types |
CallbackUrl | This is the URL that we will send the JSON to once a qualifying event has happened. |
CallbackAuthenticationToken | This is a token to authenticate back to the CallbackUrl. |
HTTP Verb: POST
URI: https://webhooks.services.10-4.com/api/subscription
Authentication: Webhook Bearer Token
Sample POST:
{
"EventType": "Stop.Departed",
"CallbackUrl": "https://www.mytestsite.com",
"CallbackAuthenticationToken" : "tokenTest"
}
Response:
{
"data": [
{
"subscriptionId": 139,
"organizationGuid": "{{GUID}}",
"linkBaseName": "https://develop.trimblevisibility.tech",
"eventType": "Stop.Departed",
"createdDate": "2019-03-26T02:31:38+00:00",
"callbackUrl": "https://www.mytestsite25.com",
"callbackAuthenticationToken": "tokenTest",
"updatedByUserGuid": "{{GUID}}",
"adminEmailAddress": "[email protected]"
}
],
"messages": [],
"totalPossibleCount": 0
}
Updated about 2 months ago