SHshipengine
webhooks

Update a Webhook

Changed on

Update the webhook url property

put/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

Request body

urlstring url

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 Updated Webhook",
  "store_id": 123456
}

Response

The request was successful.

string required

Changes

  • bacb12a49a2bRevision changes
    • info

      added the new optional request property

    • info

      added the new optional request property

  • 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