Events · People and access
user.offboarded
User offboarded
A user was offboarded: their cards and tasks were handed over, and the account was deactivated.
- Object type
- user
- Delivered to
- Endpoints with the admin role
Payload
idstringrequiredEvent ID (
evt_…), also sent as thewebhook-idheader. Use it to drop duplicate deliveries.typestringrequiredAllowed values:
user.offboardedcreated_atstring (date-time)requiredWhen the change happened (UTC).
org_idintegerrequiredapi_versionstringrequiredContract version of the
dataschema.sequenceintegerDelivery sequence number within the endpoint (absent for a test event).
payloadstringrequiredthinmeans nodata: read the object through the API.Allowed values:
fullthindataobjectFields
actor_idinteger | nullrequiredThe user who performed the action;
nullfor an organization API key or the platform itself.offboardingobjectrequiredFields
transferred_tointegerrequiredWho received the ownership.
api_keys_revokedintegercardsintegerverifier_ofintegercollectionsintegersourcesinteger
testbooleanrequiredA test event sent by
POST /v1/webhooks/{webhook_id}/test.
Example delivery
{
"id": "evt_0123456789abcdef0123456789abcdef",
"type": "user.offboarded",
"created_at": "2026-10-24T10:00:03Z",
"org_id": 1,
"api_version": "1.62.0",
"sequence": 1042,
"object": {
"type": "user",
"id": "11"
},
"payload": "full",
"data": {
"user": {
"id": 11,
"username": "anna",
"display_name": "Anna Smith",
"email": "anna@example.com",
"role": "editor",
"active": false
},
"actor_id": 7,
"offboarding": {
"transferred_to": 7,
"api_keys_revoked": 1,
"cards": 12,
"verifier_of": 4,
"collections": 0,
"sources": 1
}
},
"test": false
}Receiving events
Each delivery is a POST request with this JSON body to your endpoint. Verify the webhook-signature header (Standard Webhooks) before you trust the body, answer with a 2xx status within a few seconds, and do the work afterwards. Deliveries to one endpoint keep the order of events; a failed delivery is retried with growing pauses.
New event types and new fields can appear at any time: skip the types and fields you do not know.