Sign in

v1

latestOpenAPI 3.0.02026-07-1397337495.2 KB
webhooks

List Webhooks

List all webhooks currently enabled for the account.

get/v1/environment/webhooks

Response

The request was a success.

webhook_idstring

A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.

urlstring url

A URL

event'batch' | 'carrier_connected' | 'order_source_refresh_complete' | 'rate' | 'report_complete' | 'sales_orders_imported' | 'track'

The possible webhook event values

namestring

The name of the webhook

store_idinteger

Store ID

Example response

[
  {
    "webhook_id": "se-28529731",
    "url": "http://api.shipengine.com/v1/labels/se-28529731",
    "headers": [
      {
        "key": "custom-key",
        "value": "custom-value"
      }
    ],
    "name": "My Webhook",
    "store_id": 123456
  }
]