Skip to content
Ordinal
Esc
↑↓navigate↵open⌘Jpreview

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.

SENDinvite.created
Message
application/json
typestring

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

dataobject

Event-specific payload for this webhook.

Show properties
inviteobject

The invite.

Show properties
idstring

Invite ID.

emailstring

Email address of the invited user.

createdAtstring<date-time>

ISO 8601 timestamp when the invite was created.

invitedByUser

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

Show properties
idstring<uuid>

User ID.

firstNamestring | null

First name. Can be null.

lastNamestring | null

Last name. Can be null.

emailstring<email>

Email address.

workspaceWorkspace

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

Show properties
idstring<uuid>

Workspace ID.

slugstring

Workspace slug.

namestring

Workspace name.

sentEmailboolean

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

createdAtstring<date-time>

ISO 8601 timestamp when the webhook event was created.

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