VIvibes
Webhooks

User event

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.

postWebhookuserEvent

Headers

X-Vibes-Eventclassunknown required

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

X-Vibes-Signatureunknown required

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

Payload

agentIdstring

The agent's unique identifier.

sendTimestring Timestamp

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

senderPhoneNumberstring

User device phone number in E.164 format.

eventType'EVENT_TYPE_UNSPECIFIED' | 'DELIVERED' | 'IS_TYPING' | 'READ' | 'UNSUBSCRIBE' | 'SUBSCRIBE'

The type of user event.

eventIdstring

Unique identifier of the event.

messageIdstring

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

Example payload

{
  "sendTime": "2014-10-02T15:01:23Z",
  "senderPhoneNumber": "+15555555555"
}

Response

Return 200 to acknowledge receipt of the webhook.

Changes

Webhooks have no change history: a webhook is keyed by its event name rather than a path and method, so no recorded change can name it.