> ## Documentation Index
> Fetch the complete documentation index at: https://ordinal.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# 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.

**type** `string` *required*

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

**data** `object` *required*

Event-specific payload for this webhook.

**Data object parameters**

**invite** `object` *required*

The invite.

**Invite object parameters**

**id** `string` *required*

Invite ID.

**email** `string` *required*

Email address of the invited user.

**createdAt** `string` *required*

ISO 8601 timestamp when the invite was created.

**invitedBy** `object` *required*

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

**workspace** `object` *required*

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

**sentEmail** `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`).

**createdAt** `string` *required*

ISO 8601 timestamp when the webhook event was created.

```json Example theme={null}
{
  "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"
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.