Invite sent

Triggered when a user invite email is sent

To subscribe to this webhook, please set up a URL endpoint capable of receiving POST requests.

Request Details

The request will POST a JSON payload that conforms to the following Typescript interface:

  "user": {
    "id": "string",
    "name": "string",
    "email": "string",
    "customAttributes": {
      "team": "string",
      "dob": "date",
    }
  },
  "portal": {
    "id": "string"
  },
  "meta": {
    "timestamp": "date",
    "eventName": "invite.sent"
  },
  "invite": {
    "objectId": "string",
    "expiryDate": "date",
    "inviteEmail": "string",
    "targetId": "string",
    "personalMessage": "string",
    "totalTries": 1
  }
}