Sign in

v1

latestOpenAPI 3.1.02026-07-2277219695.0 KB
Webhooks

Create a new webhook

Creates a new webhook to send notifications to a URL when a specific event occurs.

post/webhooks

Request body

event'transaction_created' | 'transaction_updated' | 'track_updated' | 'batch_created' | 'batch_purchased' | 'all' required

Type of event that triggered the webhook.

urlstring required

URL webhook events are sent to.

activeboolean

Determines whether the webhook is active or not.

is_testboolean

Determines whether the webhook is a test webhook or not.

Example request

{
  "event": "track_updated",
  "url": "https://example.com/shippo-webhook",
  "active": true
}

Response

Webhook

eventstring required

Type of event that triggers the webhook.

urlstring required

URL webhook events are sent to.

activeboolean

Determines whether the webhook is active or not.

is_testboolean

Determines whether the webhook is a test webhook or not.

object_createdstring date-time

Timestamp of the creation of the webhook.

object_idstring

Unique identifier of the webhook. This can be used to retrieve or delete the webhook.

object_updatedstring date-time

Timestamp of the last update of the webhook.

object_ownerstring

Username of the user who created the webhook.

Example response

{
  "event": "track_updated",
  "url": "https://example.com/shippo-webhook",
  "active": true
}