Update a Webhook

put

https://api.tive.com/public/v3/Webhooks/{webhookId}

Update information about a specific webhook within your organization.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

webhookId

int32

required

ID of the webhook.

Body Params

name

string

required

length ≥ 1

The unique name of the webhook.

url

string

required

length ≥ 1

The URL of where webhook data is being sent.

description

string | null

A description of what the webhook is being used for.

version

string | null

The webhook version. Each version has different data template.

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

httpMethod

string | null

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

contentType

string | null

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

enabled

boolean

required

Determines if the webhook is enabled or not.

applyToAllTrackers

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.

applyToAllShipments

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.

applyToAllAlertPresets

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.

authentication

object

Headers

x-tive-account-id

int32

required

ID of the account the request will be made in.

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

200

The webhook has been updated

400

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

401

Unauthorized

Language

Loading…

Response

Click Try It! to start a request and see the response here!