List webhooks

Returns a list of webhooks.

You can use optional parameters to filter webhooks. For example, use enabled=true to return only webhooks that are currently enabled.

SecurityCommonAuth
Request
query Parameters
limit
integer <int32> (limit) [ 1 .. 100000 ]
Default: 100

The maximum number of items to return.

Example: limit=100
offset
integer <int32> (offset)
Default: 0

The number of items to skip before returning the results.

Example: offset=200
webhookEventTypeId
string <uuid> (webhookEventTypeId) <= 36 characters

Optional ID of the webhook event type to filter the response with.

Example: webhookEventTypeId=da91434a-4026-42ea-84b8-d0317b64af9c
enabled
boolean

Optional query parameter to filter the response with (whether the webhook is enabled or not).

Example: enabled=true
webhookEventTypeName
string <= 256 characters

Optional name of the webhook event type to filter the response with.

Example: webhookEventTypeName=OrderCreated
accountId
string (accountId)

Account ID to filter the response with (required for user-level API key).

Example: accountId=F50091
Responses
200

OK

400

Bad request

401

Unauthorised

403

Forbidden

404

Not found

405

Method not allowed

415

Unsupported media type

429

Too many requests

500

Internal server error

get/webhooks
Request samples 
Response samples 
application/json
{
  • "limit": 100,
  • "offset": 200,
  • "count": 67,
  • "search": "string",
  • "rows": [
    ]
}