Sign in

v1

latestOpenAPI 3.1.02026-08-063776831.4 MB
Webhook

Find Webhooks by filter criteria with pagination and sorting

Returns a paginated filtered list of all Webhooks based on the provided criteria. Supports both offset-based (page/size) and cursor-based (startAfter/endAt) pagination. Results can be sorted by any Webhook field using the order parameter.

get/webhooks

Query parameters

endAtIdstring

End at document ID, for backward cursor-based pagination

filterstring

Filter criteria. The filter parameter must be URL encoded when sent.

Examples (before URL encoding):

  • Filter by tenant: {"tenantId":{"eq":"tenant-123"}}

  • Filter by event type: {"data.eventTypes":{"contains":"credential_workflow.status.changed"}}

  • Filter by active status: {"data.isActive":{"eq":true}}

  • Combined filter: {"tenantId":{"eq":"tenant-123"},"data.eventTypes":{"contains":"event.type"},"data.isActive":{"eq":true}}

Example curl commands:


# Filter by tenant and event type

curl -X GET 'http://localhost:8080/webhooks?filter=%7B%22tenantId%22%3A%7B%22eq%22%3A%22tenant-123%22%7D%2C%22data.eventTypes%22%3A%7B%22contains%22%3A%22credential_workflow.status.changed%22%7D%7D'

Available filter operations:

  • eq: Equal to

  • neq: Not equal to

  • in: Value must be one of these (array)

  • nin: Value must not be any of these (array)

  • contains: String contains (case-sensitive, string fields only) or array contains (for data.eventTypes)

Filterable fields:

  • tenantId: Tenant identifier (String)

  • data.eventTypes: Array of event types (Array - supports contains, eq, in)

  • data.isActive: Whether the webhook is active (Boolean - supports eq, neq)

  • data.webhookUrl: Webhook URL (String - optional)

Note: When using the filter parameter in a browser or code, make sure to properly URL encode the JSON string.

orderstring

Sort criteria. The order parameter must be URL encoded when sent.

Example (before URL encoding):

  • Sort by createdAt descending: {"orderBy":"createdAt","orderByDirection":"DESC"}

Example curl command:


# Sort by createdAt descending

curl -X GET 'http://localhost:8080/webhooks?order=%7B%22orderBy%22%3A%22createdAt%22%2C%22orderByDirection%22%3A%22DESC%22%7D'

Note: When using the order parameter in a browser or code, make sure to properly URL encode the JSON string.

pageinteger

Page number (0-based), for offset-based pagination

sizeinteger

Page size

startAfterIdstring

Start after document ID, for forward cursor-based pagination

Headers

tenant-idstring required

Tenant ID

Response

List of Webhooks

totalCountinteger

Total count of webhooks

Example response

{
  "totalCount": 100,
  "data": [
    {
      "id": "webhook-123",
      "tenantId": "tenant-123",
      "createdBy": "user-123",
      "updatedBy": "user-123",
      "createdAt": "2022-03-10T16:15:50Z",
      "updatedAt": "2022-03-10T16:15:50Z"
    }
  ]
}