Server event

wbhk

serverEvent

An event that occurred server side that is related to a conversation between an agent and a user.

Payload

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

A server-generated event reporting about a previously sent agent message, such as delivery, failure, or revocation.

agentId

string

The agent's unique identifier.

sendTime

string

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

phoneNumber

string

Recipient device phone number in E.164 format.

messageId

string

Identifier of the agent message this event relates to.

eventType

string

enum

The type of server event.

Allowed:

eventId

string

Unique identifier of the event.

eventOrigin

string

enum

Source from which the event originated. Set only for custom SENT or FAILED events.

Allowed:

errorCode

string

Error code, present when the event indicates a failure.

errorMessage

string

Human-readable error description, present when the event indicates a failure.

richMessageClassification

object

Billing classification for a server event's related message.

totalPayloadSizeBytes

int64

Total payload size of the related message in bytes.

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.