Get webhook by ID

Changed on Oct 22, 2026

Retrieve individual webhook by an ID

get/v1/environment/webhooks/{webhook_id}

Request

Base URL: https://api.shipengine.com
URL: https://api.shipengine.com/v1/environment/webhooks/{webhook_id}
Auth: API key in header API-Key

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

The possible webhook event values

namestring

The name of the webhook

store_idinteger

Store ID

Example response

{
  "webhook_id": "se-28529731",
  "url": "https://example.com/resource",
  "event": "batch",
  "headers": [
    {
      "key": "custom-key",
      "value": "custom-value"
    }
  ],
  "name": "My Webhook",
  "store_id": 123456
}

Changes

Oct 22, 2026e998dffc42be Revision changes
- warning
  added the new bring_your_own_label_not_supported enum value to the // response property for the response status
- warning
  added the new bring_your_own_label_not_supported enum value to the // response property for the response status
- warning
  added the new bring_your_own_label_not_supported enum value to the // response property for the response status
- warning
  added the new multiple_sales_orders enum value to the // response property for the response status
- warning
  added the new multiple_sales_orders enum value to the // response property for the response status
- warning
  added the new multiple_sales_orders enum value to the // response property for the response status
- warning
  added the new sales_order_link_required enum value to the // response property for the response status
- warning
  added the new sales_order_link_required enum value to the // response property for the response status
- warning
  added the new sales_order_link_required enum value to the // response property for the response status
Oct 9, 2026020f57d6f5b8 Revision changes
- breaking
  the / response's property type changed from no type to string for status
- breaking
  the // response's property type changed from no type to object for status
- breaking
  the / response's property type changed from no type to object for status
- breaking
  the / response's property type changed from no type to object for status
- breaking
  the / response's property type changed from no type to object for status
- warning
  added the new batch enum value to the / response property for the response status
- warning
  added the new carrier_connected enum value to the / response property for the response status
- warning
  added the new order_source_refresh_complete enum value to the / response property for the response status
- warning
  added the new rate enum value to the / response property for the response status
- warning
  added the new report_complete enum value to the / response property for the response status
- warning
  added the new sales_orders_imported enum value to the / response property for the response status
- warning
  added the new track enum value to the / response property for the response status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  removed from the / response property allOf list for the response status
- info
  removed from the / response property allOf list for the response status
- info
  removed from the / response property allOf list for the response status
- info
  removed from the / response property allOf list for the response status
- info
  removed from the // response property allOf list for the response status
- info
  added the required property /// to the response with the status
- info
  added the required property /// to the response with the status
- info
  added the required property // to the response with the status
- info
  added the required property // to the response with the status
- info
  added the required property // to the response with the status
- info
  added the required property // to the response with the status
- info
  added the required property // to the response with the status
- info
  added the required property // to the response with the status
- info
  added the required property // to the response with the status
- info
  added the required property // to the response with the status
- info
  added the required property // to the response with the status
- info
  added the required property // to the response with the status
- info
  added the required property // to the response with the status
- info
  added the required property // to the response with the status

Operation history (4 revisions)