Search Webhook Events
Search for webhook events using a flexible query language.
Webhook events are the individual delivery records for your webhooks — one per event, per webhook. Use this endpoint to find events (for example, all failed deliveries for a given webhook in a time window) before re-running them.
Data Freshness
Do not use search for read-after-write flows because the data will not be immediately available to search. Under normal operating conditions, data is searchable within approximately 1 minute of creation or modification. Propagation could be delayed during an outage.
Retention
Webhook events are retained for a limited window. Searches are automatically bounded to that window, so events older than the retention period are not returned even if requested.
Searchable Attributes
The following attributes can be used in query predicates:
| Attribute | Description |
|---|---|
| updated_at | Timestamp the event was last updated (i.e. last delivery attempt). Supports eq, gt, gte, lt, lte. |
| status | Delivery status: pending, completed, failed, or skipped. |
| webhook_id | Webhook token (e.g. wbh_ABC123). |
| event_id | Event token the webhook event was created from (e.g. evt_ABC123). |
| event_name | Event name (e.g. inquiry.completed). |
| webhook_event_id | Webhook event token (e.g. wbhe_ABC123). |
| related_object_ids | A related object token contained in the event payload. |
All attributes other than updated_at support only the eq operator.
Request
- Base URL: https://api.withpersona.com/api/v1
- URL: https://api.withpersona.com/api/v1/webhook-events/search
- Auth: HTTP bearer
Query parameters
Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See Serialization for more details.
Headers
Determines casing for the API response.
Ensures the request is idempotent.
Server API version. More info on versioning can be found here.
Request body
Response
This endpoint returns a collection of Webhook Event objects matching the search criteria.
Changes
No recorded changes to this operation across all 1 revision of this API.