List Webhooks​

GET
/webhooks

Returns webhook configurations for the selected organization. Filter by event type, sort the results, and page through the list. For eventTypes, [?] matches a webhook subscribed to the specified event; [*] matches a webhook subscribed to exactly that single event.

Use cases

  • Show configured event destinations in an integration settings page.
  • Find webhooks subscribed to a particular charger or session event.

Related endpoints

  • POST /webhooks — add a destination.
  • GET /webhooks/{webhookId} — inspect one destination.

Authorizations​

bearerAuth

Generate an API token here

Type
HTTP (bearer)

Parameters​

Header Parameters

compatibility-date*

API compatibility date in YYYY-MM-DD format. Must be a date after 2025-11-01.

Type
string
Required
Example"2025-11-02"
Pattern
^\d{4}-\d{2}-\d{2}$
organization-id*

Routes the request to the organization named by this ID. The bearer token must be authorized for that organization.

Type
string
Required
Example"3b241101-e2bb-4255-8caf-4136c566a962"
Min Length
1
Max Length
40

Query Parameters

filter

Filter criteria for webhooks. Allowed fields: id, url, enabled, eventTypes, createdAt, updatedAt. For eventTypes, [?] matches a subscription to the specified event; [*] matches a webhook subscribed to exactly that event. Use : for equality, <> for inequality, < and > for strict comparisons, <: and >: for inclusive comparisons, and ~ for substring matching. Use semicolons to AND conditions; multiple filter entries are OR alternatives.

Example"eventTypes[?]:session_stopped;enabled:true"
sort

Sort by up to 3 fields from: id, url, enabled, eventTypes, createdAt, updatedAt. Prefix with + for ascending or - for descending, and separate fields with commas.

Type
string
Example"-createdAt"
Default
"-createdAt"
Min Length
1
Max Length
256
page

1-based page number; defaults to 1.

Type
integer
Example2
Default
1
Exclusive Minimum
0
Maximum
4294967295
per_page

Maximum records returned per page. Defaults to 10 and cannot exceed 100.

Type
integer
Example25
Default
10
Exclusive Minimum
0
Maximum
100

Responses​

success.webhook.list

application/json

Number of webhook configurations matching the filters before pagination.

Minimum0
Maximum9007199254740991

Playground​

Authorization
Headers
Variables
Key
Value

Samples​