invite.created

{
  "type": "invite.created",
  "data": {
    "invite": {
      "id": "550e8400-e29b-41d4-a716-446655440600",
      "email": "newmember@example.com",
      "createdAt": "2025-02-26T11:00:00.000Z",
      "invitedBy": {
        "id": "550e8400-e29b-41d4-a716-446655440010",
        "firstName": "Jane",
        "lastName": "Doe",
        "email": "jane@example.com"
      },
      "workspace": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "slug": "acme",
        "name": "Acme Inc"
      },
      "sentEmail": true
    }
  },
  "createdAt": "2025-02-26T11:00:00.000Z"
}

All webhook payloads follow a consistent top-level structure with event-specific data nested within the data object.

string

required

The event type (e.g. invite.created).

object

required

Event-specific payload for this webhook.

Show Data object parameters

object

required

The invite.

Show Invite object parameters

string

required

Invite ID.

string

required

Email address of the invited user.

string

required

ISO 8601 timestamp when the invite was created.

object

required

User who sent the invite. Contains id, firstName, lastName, and email.

object

required

Workspace the user was invited to. Contains id, slug, and name.

boolean

required

Whether an invitation email was sent. If the invitee already had an account, they are added directly and no email is sent (false).

string

required

ISO 8601 timestamp when the webhook event was created.

{
  "type": "invite.created",
  "data": {
    "invite": {
      "id": "550e8400-e29b-41d4-a716-446655440600",
      "email": "newmember@example.com",
      "createdAt": "2025-02-26T11:00:00.000Z",
      "invitedBy": {
        "id": "550e8400-e29b-41d4-a716-446655440010",
        "firstName": "Jane",
        "lastName": "Doe",
        "email": "jane@example.com"
      },
      "workspace": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "slug": "acme",
        "name": "Acme Inc"
      },
      "sentEmail": true
    }
  },
  "createdAt": "2025-02-26T11:00:00.000Z"
}

⌘I

Overview

Social Profile

Posts

Approvals

Invites