{
"event": "run.completed",
"data": {
"runId": "<string>",
"successCount": 123,
"failureCount": 123,
"jobId": "<string>"
},
"timestamp": "2023-11-07T05:31:56Z"
}Webhooks
`runcompleted` event
Delivered as a POST to the subscribed URL. Verify X-Surfaced-Signature (HMAC-SHA256 over the raw body); X-Surfaced-Event carries the event name. Legacy name: the same payload is also delivered as brief.run.completed, which is the successor. A webhook subscribed to both names receives two deliveries.
WEBHOOK
run.completed
{
"event": "run.completed",
"data": {
"runId": "<string>",
"successCount": 123,
"failureCount": 123,
"jobId": "<string>"
},
"timestamp": "2023-11-07T05:31:56Z"
}Authorizations
API key (sk_live_...) created at https://www.getsurfaced.ai/app/settings/account/api-keys
Body
application/json
Response
200
Acknowledge with any 2xx status. Failed deliveries are retried.