webhooks

Create a webhook

Changed on

Create a webhook for specific events in the environment.

post/v1/environment/webhooks

Request

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

Request body

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

The possible webhook event values

urlstring url required

A URL

namestring

The name of the webhook

store_idinteger

Store ID

Example request

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

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": "https://example.com/resource",
  "event": "batch",
  "headers": [
    {
      "key": "custom-key",
      "value": "custom-value"
    }
  ],
  "name": "My Webhook",
  "store_id": 123456
}

Changes

  • e998dffc42beRevision 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

  • 020f57d6f5b8Revision changes
    • breaking

      added the new required request property //

    • breaking

      added the new required request property //

    • breaking

      request property was restricted to a list of enum values

    • breaking

      the request property type changed from no type to string

    • breaking

      the / request property type changed from no type to object

    • 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

      removed from the request property allOf list

    • warning

      removed from the / request property allOf list

    • 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 new batch enum value to the request property

    • info

      added the new carrier_connected enum value to the request property

    • info

      added the new order_source_refresh_complete enum value to the request property

    • info

      added the new rate enum value to the request property

    • info

      added the new report_complete enum value to the request property

    • info

      added the new sales_orders_imported enum value to the request property

    • info

      added the new track enum value to the request property

    • 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