API reference
Retrieve an event
GET
One event, in the same envelope as its webhook. Events are kept for 30 days.
Required scope: webhooks:read (webhooks:write also works).
Errors
- 400:
unknown_field - 401:
authentication_required,invalid_api_key - 403:
api_access_disabled,insufficient_scope - 404:
event_not_found - 422:
invalid_parameter - 429:
rate_limit_exceeded - 500:
api_error - 503:
service_unavailable
ApiKeyheader
AuthorizationBearer <probb_live_<id>_<secret>>id*stringThe event's ID.
Length
1 <= length <= 200Success.
application/json- response
id*stringUnique event ID, stable across retries.
object*stringtype*stringThe event type.
Value in
"candidate.created""candidate.updated""candidate.deleted""job.created""job.updated""job.closed""job.reopened""job.deleted""report.created""report.processing""report.needs_review""report.completed""report.failed""report.deleted""interview.invited""interview.started""interview.evaluating""interview.completed""interview.expired""interview.cancelled""interview.failed""interview.invitation_failed""interview.reminder_sent""decision.updated""decision.cleared""final_round.created""final_round.cancelled""final_round.scorecard_submitted""final_round.completed""candidate_kit.released""candidate_kit.viewed""candidate_kit.revoked""ping"createdAt*stringWhen the change happened, ISO-8601 UTC.
Format
date-timeactor*Who caused the change. Ignore events whose actor is your own API key to skip echoes.
data*previous?Prior values of the changed fields. Present on *.updated events only.
# Set PROBB_URL and PROBB_API_KEY. Replace any *_VALUE placeholder and any example ID (such as job_example) with a real one.curl --fail-with-body -X GET "$PROBB_URL/api/v1/events/ID_VALUE" \ -H "Authorization: Bearer $PROBB_API_KEY"Example Response
{ "id": "string", "object": "event", "type": "candidate.created", "createdAt": "2019-08-24T14:15:22Z", "actor": { "type": "api_key", "id": "string" }, "data": { "object": { "property1": null, "property2": null } }, "previous": { "property1": null, "property2": null }}