VIvibes
Webhooks

User message

The end user has sent a message, file, location, or response to your RCS agent.

postWebhookuserMessage

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.

messageIdstring

Unique identifier of the message.

textstring

Text body of the message, when the user sent text.

googleCarrierstring

Carrier reported by Google for the sender.

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.