User Events

User-related webhook events that you can listen to. For more information about webhooks, see Webhook Events.

user.availability.updated

POST

https://your-webhook-endpoint.example.com

/user.availability.updated

user.availability.updated › Request Body

UserAvailabilityUpdatedEvent

created

string · required

UTC timestamp of when the event was emitted

UserEventData · required

id

string · required

The ID of the event

organisationId

string · required

The ID of the organisation that the event belongs to

timestamp

number · required

Unix timestamp of when the event was originally emitted

type

string · const · required

Const value: user.availability.updated

version

string · required

Event version number, the version is a YYYY-mm-dd formatted string

Example: 2020-07-15

user.availability.updated › Responses

200

Return a 200 status to indicate that the data was received successfully

No data returned

POST/user.availability.updated

curl https://your-webhook-endpoint.example.com/user.availability.updated \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "created": "2026-08-20T01:18:04.206Z",
  "data": {
    "user": {
      "availability": {
        "availabilitySummary": "Marc is on another call",
        "callId": "c6c01228-2884-49d4-bc51-bf58f3c3f27e",
        "notAvailableReason": "On another call",
        "notAvailableRule": "busyOnACall",
        "status": "busy",
        "statusAt": "2026-08-20T01:18:04.207Z",
        "statusTimestamp": 1787188684207,
        "timezone": "Europe/Zagreb",
        "vendor": "twilio",
        "vendorCallId": "CA770CC3C381684134917E51262CDE5A69"
      },
      "desktopEnrolledReleaseChannel": "stable",
      "displayName": "Mr. Tom Abernathy MD",
      "email": "Ramon_Kuhic4@yahoo.com",
      "extension": 3882283,
      "firstName": "Kaycee",
      "id": "402b7e58-a505-4369-865e-db5c9b59c9be",
      "isDirectorySynced": false,
      "jobTitle": "Lead Tactics Designer",
      "lastName": "Auer",
      "licenses": [
        "enlightenPro",
        "proCx"
      ],
      "location": "Bettyeport",
      "loginStatus": "loggedIn",
      "mobile": "+11116310801",
      "phoneNumbers": [
        {
          "numberE164": "+11245823565",
          "numberLocal": "(146) 791-1734",
          "numberDisplay": "+1 148-849-5407"
        },
        {
          "numberE164": "+12133522481",
          "numberLocal": "(621) 335-2558",
          "numberDisplay": "+1 034-256-6052"
        }
      ],
      "status": "active",
      "teams": [
        "Future-proofed real-time paradigm",
        "Open-source sustainable adapter",
        "Persistent cohesive approach"
      ],
      "twimlRedirectUrl": "https://grimy-optimal.biz",
      "type": "user"
    }
  },
  "id": "77344de5-9e7d-4810-9558-c5c51b327484",
  "timestamp": 1787188684206,
  "type": "user.availability.updated",
  "version": "2020-07-15"
}'

Example Request Body

{
  "created": "2026-08-20T01:18:04.206Z",
  "data": {
    "user": {
      "availability": {
        "availabilitySummary": "Marc is on another call",
        "callId": "c6c01228-2884-49d4-bc51-bf58f3c3f27e",
        "notAvailableReason": "On another call",
        "notAvailableRule": "busyOnACall",
        "status": "busy",
        "statusAt": "2026-08-20T01:18:04.207Z",
        "statusTimestamp": 1787188684207,
        "timezone": "Europe/Zagreb",
        "vendor": "twilio",
        "vendorCallId": "CA770CC3C381684134917E51262CDE5A69"
      },
      "desktopEnrolledReleaseChannel": "stable",
      "displayName": "Mr. Tom Abernathy MD",
      "email": "Ramon_Kuhic4@yahoo.com",
      "extension": 3882283,
      "firstName": "Kaycee",
      "id": "402b7e58-a505-4369-865e-db5c9b59c9be",
      "isDirectorySynced": false,
      "jobTitle": "Lead Tactics Designer",
      "lastName": "Auer",
      "licenses": [
        "enlightenPro",
        "proCx"
      ],
      "location": "Bettyeport",
      "loginStatus": "loggedIn",
      "mobile": "+11116310801",
      "phoneNumbers": [
        {
          "numberE164": "+11245823565",
          "numberLocal": "(146) 791-1734",
          "numberDisplay": "+1 148-849-5407"
        },
        {
          "numberE164": "+12133522481",
          "numberLocal": "(621) 335-2558",
          "numberDisplay": "+1 034-256-6052"
        }
      ],
      "status": "active",
      "teams": [
        "Future-proofed real-time paradigm",
        "Open-source sustainable adapter",
        "Persistent cohesive approach"
      ],
      "twimlRedirectUrl": "https://grimy-optimal.biz",
      "type": "user"
    }
  },
  "id": "77344de5-9e7d-4810-9558-c5c51b327484",
  "timestamp": 1787188684206,
  "type": "user.availability.updated",
  "version": "2020-07-15"
}

json

application/json

Example Responses

No example specified for this content type

Call Annotation Events Contact Events

user.availability.updated

POST

https://your-webhook-endpoint.example.com

/user.availability.updated

user.availability.updated › Request Body

UserAvailabilityUpdatedEvent

created

string · required

UTC timestamp of when the event was emitted

UserEventData · required

id

string · required

The ID of the event

organisationId

string · required

The ID of the organisation that the event belongs to

timestamp

number · required

Unix timestamp of when the event was originally emitted

type

string · const · required

Const value: user.availability.updated

version

string · required

Event version number, the version is a YYYY-mm-dd formatted string

Example: 2020-07-15

user.availability.updated › Responses

200

Return a 200 status to indicate that the data was received successfully

No data returned