Onboarding

Onboarding events: 4 in all. See the shared envelope.

onboarding.approved

The onboarding application was approved.

Resource: onboarding

Not supported by `events trigger` (use the normal API flow).

Example payload
{
  "id": "wev_HEXJV5xvEuzfL3nemfGMhmTgP64",
  "type": "onboarding.approved",
  "api_version": "v1",
  "tenant_id": "ten_dMtYBHqoMswJA34fM24koBkTzKe",
  "created_at": "2026-11-19T09:30:00Z",
  "data": {
    "resource_type": "onboarding",
    "resource_id": "onb_HEXJV5xvEutcfkkotpZLS4Qpifg",
    "resource": {
      "type": "onboarding",
      "id": "onb_HEXJV5xvEutcfkkotpZLS4Qpifg",
      "sequence": 1
    }
  }
}

onboarding.information_requested

The platform asked for more onboarding information.

Resource: onboarding

Not supported by `events trigger` (use the normal API flow).

Example payload
{
  "id": "wev_HEXJV5xvEuz8XQz9hReApSkAn7B",
  "type": "onboarding.information_requested",
  "api_version": "v1",
  "tenant_id": "ten_dMtYBHqoMswJA34fM24koBkTzKe",
  "created_at": "2026-11-19T09:30:00Z",
  "data": {
    "resource_type": "onboarding",
    "resource_id": "onb_HEXJV5xvEutcfkkotpZLSbM9hJn",
    "resource": {
      "type": "onboarding",
      "id": "onb_HEXJV5xvEutcfkkotpZLSbM9hJn",
      "sequence": 1
    }
  }
}

onboarding.rejected

The onboarding application was rejected.

Resource: onboarding

Not supported by `events trigger` (use the normal API flow).

Example payload
{
  "id": "wev_HEXJV5xvEuzztQjrkExeeggp2ho",
  "type": "onboarding.rejected",
  "api_version": "v1",
  "tenant_id": "ten_dMtYBHqoMswJA34fM24koBkTzKe",
  "created_at": "2026-11-19T09:30:00Z",
  "data": {
    "resource_type": "onboarding",
    "resource_id": "onb_HEXJV5xvEutcfkkotpZLSLELezp",
    "resource": {
      "type": "onboarding",
      "id": "onb_HEXJV5xvEutcfkkotpZLSLELezp",
      "sequence": 1
    }
  }
}

onboarding.submitted

The onboarding application was submitted.

Resource: onboarding

Not supported by `events trigger` (use the normal API flow).

Example payload
{
  "id": "wev_HEXJV5xvEuzCCwVjnEZZwvLqDoo",
  "type": "onboarding.submitted",
  "api_version": "v1",
  "tenant_id": "ten_dMtYBHqoMswJA34fM24koBkTzKe",
  "created_at": "2026-11-19T09:30:00Z",
  "data": {
    "resource_type": "onboarding",
    "resource_id": "onb_HEXJV5xvEutcfkkotpZLSXJguSh",
    "resource": {
      "type": "onboarding",
      "id": "onb_HEXJV5xvEutcfkkotpZLSXJguSh",
      "sequence": 1
    }
  }
}

Receiving these events

Your webhook endpoint receives each of these events as a POST with the shared envelope described in the table below. Check the signature before acting on it, answer quickly with a 2xx code and do the work afterwards: a slow or failed answer is sent again. The same event can arrive more than once, so use its id to ignore repeats.

FieldTypeMeaning
idstringThe event identifier; the same on every delivery attempt.
typestringThe event name, for example invoice.issued.
api_versionstringThe API version the body is written in.
tenant_idstringThe utility (workspace) where the event happened.
created_atstring (RFC 3339)When the event was recorded.
request_idstringThe API request that caused the change, when there was one; links to the request log.
data.resource_typestringThe type of the resource that changed.
data.resource_idstringThat resource's identifier, to read it from the API.
data.attributesobjectFields specific to each event; may be absent. Read the resource from the API for its full state.
data.resource.sequenceintegerCounts the events about the same resource; ignore an event that is not newer than the last one you applied.

Other event categories