v1

latestOpenAPI 3.1.02026-07-134488210.8 KB

Webhooks

Create or Update Webhook

Create webhook for store. Or if webhook already exists with externalId, update it. Requires the webhooks_write scope.

post/stores/{storeId}/webhooks

Request body

Example request

{
  "webhook": {
    "callback": {
      "auth": {
        "bearer": {
          "token": "abc123"
        }
      },
      "url": "https://subscriber.example.org/events"
    }
  }
}

Response

Updated

Example response

{
  "webhook": {
    "callback": {
      "auth": {
        "bearer": {
          "token": "abc123"
        }
      },
      "url": "https://subscriber.example.org/events"
    }
  }
}