User event

wbhk

userEvent

An event coming from an end user's RCS client in conversation with your RCS agent. This could be a delivery message, a notification that the end user is typing, a read receipt or (un)subscribe action.

Payload

An HTTP POST body that contains event data serialized in JSON format.

An event generated by the user's device, such as a delivery receipt, typing indicator, read receipt, or (un)subscribe.

agentId

string

The agent's unique identifier.

sendTime

string

Timestamp (RFC 3339) at which the webhook event was sent.

senderPhoneNumber

string

User device phone number in E.164 format.

eventType

string

enum

The type of user event.

Allowed:

eventId

string

Unique identifier of the event.

messageId

string

Identifier of the related agent message. This field is populated for DELIVERED and READ events.

Headers

X-Vibes-Eventclass

string

required

An HTTP header that indicates what type of event class the callback is. Options are ServerEvent, UserEvent, or UserMessage.

X-Vibes-Signature

string

required

An HTTP header that contains a BASE64 encoded HMAC SHA512 signature.

Response

200

Return 200 to acknowledge receipt of the webhook.