List all webhooks

GET 
/v1/webhooks

Retrieve all webhooks.

Responses

200

application/json

Schema

Schema

count integernullable
next urinullable
previous urinullable

results

object[]

required

Array [

id string

A unique identifier

url urirequired

The URL of the webhook endpoint.

description stringnullable

An optional description of what the webhook is used for.

enabled_events string[]required

Possible values: [all, shipment_purchased, shipment_cancelled, shipment_fulfilled, shipment_out_for_delivery, shipment_needs_attention, shipment_delivery_failed, tracker_created, tracker_updated, order_created, order_updated, order_fulfilled, order_cancelled, order_delivered, batch_queued, batch_failed, batch_running, batch_completed]

The list of events to enable for this endpoint.

disabled booleannullable

Indicates that the webhook is disabled

object_type string

Default value: webhook

Specifies the object type

last_event_at date-timenullable

The datetime of the last event sent.

secret stringrequired

Header signature secret

test_mode booleanrequired

Specified whether it was created with a carrier in test mode

]

Example (from schema)

{
  "count": 0,
  "next": "string",
  "previous": "string",
  "results": [
    {
      "id": "string",
      "url": "string",
      "description": "string",
      "enabled_events": [
        "all"
      ],
      "disabled": true,
      "object_type": "webhook",
      "last_event_at": "2024-07-29T15:51:28.071Z",
      "secret": "string",
      "test_mode": true
    }
  ]
}

404

application/json

Schema

Schema

errors

object[]

The list of API errors

Array [

message string

The error or warning message

code string

The message code

details

object

any additional details

property name* any

any additional details

]

Example (from schema)

{
  "errors": [
    {
      "message": "string",
      "code": "string",
      "details": {}
    }
  ]
}

500

application/json

Schema

Schema

errors

object[]

The list of API errors

Array [

message string

The error or warning message

code string

The message code

details

object

any additional details

property name* any

any additional details

]

Example (from schema)

{
  "errors": [
    {
      "message": "string",
      "code": "string",
      "details": {}
    }
  ]
}

Loading...