BlogContact Us
API Reference

Create a Webhook

post
https://api.tive.com/public/v3/Webhooks

Create a webhook for the specified accounts.

Body Params
string
required
length ≥ 1

The unique name of the webhook.

string
required
length ≥ 1

The URL of where webhook data is being sent.

string | null

A description of what the webhook is being used for.

string | null

The webhook version. Each version has different data template.

string | null

The template of data being sent in the webhook. If null, the default template will be used.

headers
array of objects | null

Optionally provides the ability to pass along custom data such as a client secret.

headers
accountIds
array of int32s | null

A list of account IDs associated with the webhook.

accountIds
string | null

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

string | null

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

boolean
required

Determines if the webhook is enabled or not.

boolean

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

boolean

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

boolean

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

Headers
int32
required

ID of the account the request will be made in.

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

400

Unable to create the webhook. See response message for details.

401

Unauthorized

Updated 7 months ago

Language
Response 
Click Try It! to start a request and see the response here!
Updated 7 months ago