Sign in

v1

latestOpenAPI 3.0.12026-07-2487135176.5 KB
Webhooks

Create a Webhook

Create a webhook for the specified accounts.

post/public/v3/Webhooks

Headers

x-tive-account-idinteger required

ID of the account the request will be made in.

Request body

namestring required

The unique name of the webhook.

urlstring required

The URL of where webhook data is being sent.

descriptionstring nullable

A description of what the webhook is being used for.

versionstring nullable

The webhook version. Each version has different data template.

templatestring nullable

The template of data being sent in the webhook. If null, the <a href="https://developers.tive.com/docs/data-structures">default template</a> will be used.

accountIdsinteger[] nullable

A list of account IDs associated with the webhook.

httpMethodstring nullable

The HTTP method used in the webhook request. Values include POST, PUT, or PATCH. Defaults to POST.

contentTypestring nullable

The type of content being transmitted in the request. Defaults to application/json.

enabledboolean required

Determines if the webhook is enabled or not.

applyToAllTrackersboolean

The webhook will be triggered for every device measurement within the applicable account(s). <em>At least one</em> of the applyToAll fields must be set to true.

applyToAllShipmentsboolean

Apply the webhook to trigger on all shipment events within the applicable account(s). <em>At least one</em> of the applyToAll fields must be set to true.

applyToAllAlertPresetsboolean

Apply the webhook to trigger on all alert preset alerts within the applicable account(s). <em>At least one</em> of the applyToAll fields must be set to true.

Response

The created webhook id

integer required