Skip to navigation
File SearchWebhooksWebhook events

job.cancelled

Sent when an indexing job is cancelled with DELETE /v2/jobs/{job_id}. The job’s final status is cancelled and data.error_code is null.

data.files counts the files that were indexed before the job was cancelled.

Each indexing job sends exactly one event, when it reaches its final status. See Webhooks to add an endpoint and verify signatures.

Headers

webhook-idstringRequired
A unique id for this message. It stays the same on every retry and resend. Deduplicate on it.
webhook-timestampstringRequired
When this attempt was sent, in Unix seconds.
webhook-signaturestringRequired

One or more space-separated signatures, each v1, followed by a base64 HMAC-SHA256 of {webhook-id}.{webhook-timestamp}.{body} made with the endpoint's signing secret.

Payload

The payload of this webhook request is an object.
idstringRequired

evt_ followed by the job id. The same for every delivery of this job's event.

typeenumRequired
The event name.
Allowed values:
timestampstringRequiredformat: "date-time"
When the job finished, in ISO 8601 UTC.
dataobjectRequired
The indexing job the event reports on.

Response

200

Return any 2xx status within a few seconds to acknowledge the event. Any other status, or no response, is retried.