invite.created

Fired when a user is invited to the workspace. If the invitee already has an account, they are added directly and no email is sent.

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

PropType

typestring

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

Typestring

dataobject

Event-specific payload for this webhook.

Typeobject

data.inviteobject

The invite.

Typeobject

data.invite.idstring

Invite ID.

Typestring

data.invite.emailstring

Email address of the invited user.

Typestring

data.invite.createdAtstring

ISO 8601 timestamp when the invite was created.

Typestring

data.invite.invitedByobject

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

Typeobject

data.invite.workspaceobject

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

Typeobject

data.invite.sentEmailboolean

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

Typeboolean

createdAtstring

ISO 8601 timestamp when the webhook event was created.

Typestring

{
  "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"
}