Webhook notifications

Notifications of events, sent to webhooks

Endpoints
GET/webhook_notifications

The webhook notification object

Attributes

iduuid

Unique identifier

webhook_iduuid
webhooks.id

Identifier of the related webhook

created_attimestamp with time zone

Creation timestamp

updated_attimestamp with time zone

Last modification timestamp

created_ondate

Date on which the notification was created

event_typeWebhookEvent

Event this notification is for

next_attempt_attimestamp with time zone

When the next delivery attempt is due, or the end of the claim of the attempt in progress

payloadjsonb

JSON payload that is sent along with this notification: the object before (old, null for .created events) and after (new) the change. Member events add the user's name and email to both under user_profiles

responsetext | null

Response body or error of the last delivery attempt, cut to 2,000 characters

statusWebhookNotificationStatus

Status of the notification

triesinteger

Number of delivery attempts

Related resources

Embed related resources in the response with the select parameter, for example select=*,webhooks(*). See selecting data. Resources related through more than one column need the column as a hint, like table!column(*).

webhooks(*)object | null
webhooks.id

The webhook referenced by webhook_id.

The webhook notification object
JSON
{
  "id": "00000000-0000-0000-0000-000000000000",
  "webhook_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2026-01-01T12:00:00+00:00",
  "updated_at": "2026-01-01T12:00:00+00:00",
  "created_on": "2026-01-01",
  "event_type": "candidates.created",
  "next_attempt_at": "2026-01-01T12:00:00+00:00",
  "payload": {},
  "response": "",
  "status": "sent",
  "tries": 0
}
Including related resources
curl "https://api.cv-transformer.com/v1/webhook_notifications?limit=10&select=*,webhooks(*)" \
  -H "Authorization: Bearer YOUR_API_KEY"

List webhook notifications

Requireswebhooks:read

Filters

idFilter<uuid>

Unique identifier

webhook_idFilter<uuid>
webhooks.id

Identifier of the related webhook

created_atFilter<timestamp with time zone>

Creation timestamp

updated_atFilter<timestamp with time zone>

Last modification timestamp

created_onFilter<date>

Date on which the notification was created

event_typeFilter<WebhookEvent>

Event this notification is for

next_attempt_atFilter<timestamp with time zone>

When the next delivery attempt is due, or the end of the claim of the attempt in progress

payloadFilter<jsonb>

JSON payload that is sent along with this notification: the object before (old, null for .created events) and after (new) the change. Member events add the user's name and email to both under user_profiles

responseFilter<text | null>

Response body or error of the last delivery attempt, cut to 2,000 characters

statusFilter<WebhookNotificationStatus>

Status of the notification

triesFilter<integer>

Number of delivery attempts

Responses

200

A list of webhook notifications with the selected columns. The Content-Range header holds the range returned and the total count, like 0-9/42.

206

Partial Content

400

The request is malformed, for example an unknown column or an invalid filter.

401

The API key is missing or invalid.

403

The API key doesn't have the scope this request needs.

429

The API key made more requests per minute than its rate limit allows. Retry after the number of seconds in the Retry-After header.

Errors have a JSON body with a message, details and hint, and for database errors a code. See errors.
GET/webhook_notifications
curl "https://api.cv-transformer.com/v1/webhook_notifications?limit=10&select=*" \
  -H "Authorization: Bearer YOUR_API_KEY"
Example response
JSON
[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "webhook_id": "00000000-0000-0000-0000-000000000000",
    "created_at": "2026-01-01T12:00:00+00:00",
    "updated_at": "2026-01-01T12:00:00+00:00",
    "created_on": "2026-01-01",
    "event_type": "candidates.created",
    "next_attempt_at": "2026-01-01T12:00:00+00:00",
    "payload": {},
    "response": "",
    "status": "sent",
    "tries": 0
  }
]