ResourcesWebhook Channels

List webhook channels

Retrieve the store's outbound webhook destinations.

GET
/v2/webhook-channels

Authorization

bearerAuth storeAuth
AuthorizationBearer <token>

Provide your SellApp API key as a bearer token.

In: header

X-STORE<token>

Select the SellApp store for this API request.

In: header

Query Parameters

page?integer

Page number.

Default1
Range1 <= value
limit?integer

Number of webhook channels to return per page.

Default15
Range1 <= value <= 100

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://sell.app/api/v2/webhook-channels"
{
  "data": [
    {
      "id": "0f33d01f-f9f8-45e8-80c8-7734d057196d",
      "name": "Order automation",
      "url": "https://example.com/sellapp/webhooks",
      "allowed_notifications": [
        "order.created",
        "order.paid"
      ],
      "signing_secret_configured": true
    }
  ],
  "links": {},
  "meta": {}
}
{
  "message": "Unauthenticated."
}
{
  "message": "This action is unauthorized."
}
{
  "message": "The given data was invalid.",
  "errors": {
    "data": [
      "The data field is required."
    ]
  }
}