Docs
Webhooks
Manage Webhooks Single

Manage Webhooks (Single)

Get a Webhook

GET /hooks/{webhook_id}

Request

Return a webhook by ID.

Authentication

  • X-Auth-Token in header
    required

Parameters

  • store_hash in path - string
  • Accept in header with default of application/json - string
  • Content-Type in header with default of application/json - string

example

Response

Example response

Body

object | application/json
  • data
    object

  • meta
    object

application/json

Update a Webhook

PUT /hooks/{webhook_id}

Request

Updates a webhook. Custom headers can be added.

Authentication

  • X-Auth-Token in header
    required

Parameters

  • store_hash in path - string
  • Accept in header with default of application/json - string
  • Content-Type in header with default of application/json - string

Body

object | application/json
  • scope
    string

    Event you subscribe to.

    Example: store/order/*

  • destination
    string

    URL must be active, return a 200 response, and be served on port 443. Custom ports arenʼt currently supported.

    Example: https://665b65a6.ngrok.io/webhooks

  • is_active
    boolean

    Boolean value that indicates whether the webhook is active or not.

    Example: true

  • events_history_enabled
    boolean

    Boolean value that identifies whether events are stored that could not be received.

    Example: true

  • headers
    object or null

    Headers used to validate that webhooks are active. You can pass in any number of custom headers to validate webhooks are being returned.

example

Response

Example response

Body

object | application/json
  • data
    object

  • meta
    object

application/json

Delete a Webhook

DELETE /hooks/{webhook_id}

Request

Deletes a webhook. Only one webhook at a time can be deleted. When a webhook is deleted, it is returned in the response as a 200 OK.

Authentication

  • X-Auth-Token in header
    required

Parameters

  • store_hash in path - string
  • Accept in header with default of application/json - string
  • Content-Type in header with default of application/json - string

example

Response

Example response

Body

object | application/json
  • data
    object

  • meta
    object

application/json

Did you find what you were looking for?