public_message_sender

Polymorphic sender payload returned by push_event_data. Available fields vary by sender type.

idinteger

Id of the sender

namestring | nullnullable

Name of the sender when available

avatar_urlstring

Avatar URL of the sender. Present for senders of type user, agent_bot, and assistant. Not present for contact senders (use thumbnail instead).

thumbnailstring

Avatar/thumbnail URL of the sender. Contact senders use this field; user senders may also include it.

typestring

Type of the sender

Possible values: [contact, user, agent_bot, assistant]

available_namestring | nullnullable

Display name for user senders

availability_statusstring | nullnullable

Availability status for user senders

emailstring | nullnullable

Email of the sender when the sender is a contact

phone_numberstring | nullnullable

Phone number of the sender when the sender is a contact

identifierstring | nullnullable

Identifier of the sender when the sender is a contact

blockedboolean

Whether the sender is blocked when the sender is a contact

additional_attributesobject | nullnullable

Additional attributes when the sender is a contact and available

custom_attributesobject | nullnullable

Custom attributes when the sender is a contact and available

descriptionstring | nullnullable

Description when the sender is a assistant assistant

created_atstring | nullnullable

Created timestamp in ISO 8601 format when the sender is a assistant assistant

property name*any

Polymorphic sender payload returned by push_event_data. Available fields vary by sender type.

public_message_sender

{
  "id": 0,
  "name": "string",
  "avatar_url": "string",
  "thumbnail": "string",
  "type": "contact",
  "available_name": "string",
  "availability_status": "string",
  "email": "string",
  "phone_number": "string",
  "identifier": "string",
  "blocked": true,
  "additional_attributes": "Unknown Type: object,null",
  "custom_attributes": "Unknown Type: object,null",
  "description": "string",
  "created_at": "string"
}