Headers, signing, retries and destination checks are the same for every source. See Delivery.
Job
webhook_url values must use https://. The workflow outgoing_webhook block and monitors also accept http://. Every destination must pass the URL rules.
For webhooks from the original unversioned routes, see Legacy Outgoing Webhooks.
Job webhooks
Addwebhook_url to the request that starts the Job.
cURL
job_id: you can poll GET /v1/jobs/{job_id} whether or not a webhook arrives.
Job payload
Search Jobs send this payload when the Job succeeds, fails or is canceled.
The
Sixtyfour-Event-Type header is job.succeeded, job.failed or job.canceled. Read the profiles with GET /v1/jobs/{job_id}/items.
Contacts and Intelligence
Contacts and Intelligence Jobs send the workflow payload, with download links for the result file. Itsrun_id is the Job’s job_id without the job_ prefix.
These Jobs send a webhook only when results are ready. A Job that fails or is canceled sends none, so poll GET /v1/jobs/{job_id} if no delivery arrives by your deadline.
Workflow Webhooks
Add anoutgoing_webhook block to POST the run’s results to your URL. The block sends one request per run, not per row. When no rows reach the block, for example because a filter removed every row, it sends nothing. To catch that case, poll the run with GET /v1/jobs/{job_id} when no delivery arrives.
Block specs
The block adds three columns to the workflow output:
webhook_status_code, webhook_response (first 2,000 characters) and webhook_success.
Payload
Fetch both links with an
x-api-key header from the run’s organization within 15 minutes. For fresh links, read the Job again. See Download results. A CSV link returns spreadsheet-safe cells unless you add ?spreadsheet_safe=false.
Failed rows in the payload
The payload includes rows that failed at an earlier step, withFailed in the columns their failing step would have filled. The payload has no per-row status, so identify failed rows from the final result: wait for the run to reach a finished status and read its Status column. See Failed rows and Download results. A run where every row fails ends as failed, and its results can still be downloaded.
Delivery
Headers
Sixtyfour sends the
Sixtyfour-* headers only when your organization has a signing secret. Test deliveries always add Sixtyfour-Test headers.
Retries
If every attempt fails, the delivery is dropped. The job or run itself is unaffected, and its results stay available by polling.
URL rules
Sixtyfour checks the destination before every attempt. URLs with credentials,localhost, *.local hosts, and hosts that resolve to private, loopback, link-local or other non-public IPs are rejected and not retried. A DNS lookup that fails counts as a failed attempt and is retried.
Receiver checklist
- Return
2xxwithin the timeout and process the payload asynchronously. - Return
2xxfor events you ignore. Any other status triggers retries. - Dedupe on the Job or run, not only
event_id:job_idwithstatusfor Search Jobs,run_idwithprevious_block_idfor the workflow payload, andtypewithevent_group_idorrun_idfor monitor notifications.event_idcovers only retries of one delivery, and monitor payloads have none. See the receiver example. - Once signing is enabled, reject deliveries without a valid
Sixtyfour-Signature.
Polling fallback
Results stay available whether or not a webhook is delivered:- Jobs and workflow runs:
GET /v1/jobs/{job_id}. See Async Jobs. - Monitors:
GET /v1/monitors/{monitor_id}/changes. See Monitor Endpoints.