SHshipengine
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

{
  "url": "http://api.shipengine.com/v1/labels/se-28529731",
  "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": "http://api.shipengine.com/v1/labels/se-28529731",
  "headers": [
    {
      "key": "custom-key",
      "value": "custom-value"
    }
  ],
  "name": "My Webhook",
  "store_id": 123456
}

Changes

  • bacb12a49a2bRevision changes
    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

  • e4ae9b442f54Revision changes
    • 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