User updated - Orgo Documentation

{ "id": "wh_evt_67aa128c2f4a", "event": "user.updated", "api_version": "2024-01", "created": 1735689600, "tenant_id": 1, "request": { "id": "req_8c2f4a67aa12" }, "object": { "@id": "/api/v1/users/42", "id": 42, "firstName": "James", "lastName": "Patterson", "email": "james.patterson@example.com", "status": "ACTIVE", "isFullMember": true }, "previous_attributes": { "status": "NEW", "isFullMember": false }, "is_update": true, "entity_type": "user", "operation": "updated" }

Authorizations

Api-Token

string

header

required

Server-to-server authentication. Generate a token in the admin UI at Settings → Developers → API Access. Send the raw token in the Api-Token header — there is no Bearer prefix.

Tokens can be marked read-only at creation time, in which case the API rejects any non-GET request with 403 Forbidden.

Body

application/json

string

required

Unique delivery identifier — log this to correlate with Orgo's delivery dashboard.

Example:

"wh_evt_67aa128c2f4a"

event

enum<string>

required

The event type — e.g. user.created, product_payment.updated.

Available options:

user.updated

Example:

"user.updated"

api_version

string

required

Webhook payload schema version.

Example:

"2024-01"

created

integer

required

Unix timestamp (seconds) of when the delivery was sent.

Example:

1735689600

tenant_id

integer

required

ID of the Orgo tenant the event belongs to. Use this to route deliveries in a multi-tenant receiver.

Example:

1

object

required

Snapshot of the entity at the moment the event was emitted.

Example:

{
  "@id": "/api/v1/users/42",
  "id": 42,
  "firstName": "James",
  "lastName": "Patterson",
  "email": "james.patterson@example.com",
  "status": "ACTIVE",
  "isFullMember": true
}

request

object

Metadata about the API request that triggered the event (when applicable).

Show child attributes

is_update

boolean

True for *.updated events, false otherwise.

Example:

false

entity_type

string

The entity family — e.g. user, product_payment, contact.

Example:

"user"

operation

enum<string>

The operation — created, updated, or deleted.

Available options:

created,

updated,

deleted

previous_attributes

object | null

Diff against the prior state. Only fields that changed are present. null for created/deleted events.

Example:

{ "status": "NEW", "isFullMember": false }

Response

Acknowledged. Any 2xx tells Orgo the delivery succeeded.