Sign in
latestOpenAPI 3.1.02026-08-193894215.9 MB

23dfbe1a0d1f

Members

Member Created

Sent when a member is created

Required permissions:

  • member:basic:read
  • member:email:read
  • member:phone:read
  • webhook_receive:members
postWebhookmember.created

Headers

webhook-idstring required

A unique identifier for this webhook request

Example:msg_xxxxxxxxxxxxxxxxxxxxxxxx
webhook-signaturestring required

The signature of the webhook request with the webhook version prepended

Example:v1,BASE64ENCODEDSIGNATURE
webhook-timestampstring required

The timestamp in seconds since the Unix epoch that the webhook was sent at on the server

Example:1727606400

Payload

api_version'v1' required

The API version for this webhook

api_version_datestring nullable required

The dated API version (Api-Version-Date) the payload is serialized to

company_idstring nullable

The account ID that this webhook event is associated with

idstring required

A unique ID for every single webhook request

previous_attributesobject

For some .updated events, the old values of the payload fields that changed, keyed by field name. Omitted when no capture is available for the event

timestampstring date-time required

The timestamp in ISO 8601 format that the webhook was sent at on the server

type'member.created' required

The webhook event type

Example payload

{
  "api_version": "v1",
  "api_version_date": "2026-07-20",
  "company_id": "biz_xxxxxxxxxxxxxx",
  "data": {
    "access_level": "admin",
    "account_id": "biz_xxxxxxxxxxxxxx",
    "created_at": "2026-01-01T12:00:00.000Z",
    "id": "mber_xxxxxxxxxxxxxx",
    "joined_at": "2026-01-01T12:00:00.000Z",
    "last_accessed_at": "2026-01-01T12:00:00.000Z",
    "status": "joined",
    "user": {
      "id": "user_xxxxxxxxxxxxxx",
      "name": "Dana Whitfield",
      "profile_picture": {
        "url": "https://ui-avatars.com/api/"
      },
      "username": "danawhitfield"
    }
  },
  "id": "msg_xxxxxxxxxxxxxxxxxxxxxxxx",
  "timestamp": "2025-01-01T00:00:00.000Z",
  "type": "member.created"
}

Response

Return a 200 status to indicate that the data was received successfully