---
updatedAt: 2026-08-20T15:46:20.000Z
agentTools:
  projectIndex: https://developer-aggregation.vibes.com/llms.txt
---

# Server event

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

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Vibes RCS Business Messaging API",
    "version": "0.0.0"
  },
  "security": [
    {
      "OAuth2Auth": [
        "https://rbm.vibes.com/rbm.agents"
      ]
    }
  ],
  "components": {
    "schemas": {
      "ServerEventRichMessageClassification": {
        "description": "Billing classification for a server event's related message.",
        "properties": {
          "classificationType": {
            "type": "string",
            "description": "Specifies the message's classification for billing purposes.",
            "enum": [
              "RICH_MESSAGE",
              "RICH_MEDIA_MESSAGE"
            ]
          },
          "segmentCount": {
            "type": "integer",
            "format": "int32",
            "description": "The number of 160-byte segments for the message's text, always rounded up."
          }
        }
      },
      "ServerEvent": {
        "description": "A server-generated event reporting about a previously sent agent message, such as delivery, failure, or revocation.",
        "properties": {
          "agentId": {
            "type": "string",
            "description": "The agent's unique identifier."
          },
          "sendTime": {
            "type": "string",
            "format": "Timestamp",
            "description": "Timestamp (RFC 3339) at which the webhook event was sent.",
            "example": "2014-10-02T15:01:23Z"
          },
          "phoneNumber": {
            "type": "string",
            "description": "Recipient device phone number in E.164 format.",
            "example": "+15555555555"
          },
          "messageId": {
            "type": "string",
            "description": "Identifier of the agent message this event relates to."
          },
          "eventType": {
            "type": "string",
            "description": "The type of server event.",
            "enum": [
              "EVENT_TYPE_UNSPECIFIED",
              "TTL_EXPIRATION_REVOKED",
              "TTL_EXPIRATION_REVOKE_FAILED",
              "SENT",
              "FAILED"
            ]
          },
          "eventId": {
            "type": "string",
            "description": "Unique identifier of the event."
          },
          "eventOrigin": {
            "type": "string",
            "description": "Source from which the event originated. Set only for custom SENT or FAILED events.",
            "enum": [
              "VIBES",
              "CARRIER"
            ]
          },
          "errorCode": {
            "type": "string",
            "description": "Error code, present when the event indicates a failure."
          },
          "errorMessage": {
            "type": "string",
            "description": "Human-readable error description, present when the event indicates a failure."
          },
          "richMessageClassification": {
            "$ref": "#/components/schemas/ServerEventRichMessageClassification"
          },
          "totalPayloadSizeBytes": {
            "type": "integer",
            "format": "int64",
            "description": "Total payload size of the related message in bytes."
          }
        }
      }
    },
    "securitySchemes": {
      "OAuth2Auth": {
        "type": "oauth2",
        "flows": {
          "clientCredentials": {
            "tokenUrl": "https://vibes-rbm-prd.auth.us-west-2.amazoncognito.com/oauth2/token",
            "scopes": {
              "https://rbm.vibes.com/rbm.agents": ""
            }
          }
        }
      }
    }
  },
  "servers": [
    {
      "url": "https://rbm.us.vibes.com/connectCustomers",
      "description": "Regional endpoint"
    }
  ],
  "webhooks": {
    "serverEvent": {
      "post": {
        "tags": [
          "Webhooks"
        ],
        "summary": "Server event",
        "description": "An event that occurred server side that is related to a conversation between an agent and a user.",
        "parameters": [
          {
            "name": "X-Vibes-Eventclass",
            "in": "header",
            "description": "An HTTP header that indicates what type of event class the callback is. Options are ServerEvent, UserEvent, or UserMessage.",
            "required": true,
            "schema": {},
            "example": "ServerEvent"
          },
          {
            "name": "X-Vibes-Signature",
            "in": "header",
            "description": "An HTTP header that contains a BASE64 encoded HMAC SHA512 signature.",
            "required": true,
            "schema": {},
            "example": "ltOAYccqorynA3t8MH0AVr0ncHVQF0FEdBp1q5Si8IjJN+OkXedWCOjQfwCrHe1QTpxJW1iRIu+VDBIUUssXZQ=="
          }
        ],
        "requestBody": {
          "description": "An HTTP POST body that contains event data serialized in JSON format.",
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ServerEvent"
              },
              "example": {
                "agentId": "example_agent",
                "sendTime": "2025-01-01T00:00:00.000000000Z",
                "phoneNumber": "+12223334444",
                "messageId": "be0ed04a-ff3c-4a1a-8c64-9235fb4f9073",
                "eventType": "SENT",
                "eventId": "75078f52-5ed0-4d95-95d8-0cb5a7c7dede",
                "eventOrigin": "VIBES",
                "richMessageClassification": {
                  "classificationType": "RICH_MESSAGE",
                  "segmentCount": 1
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Return 200 to acknowledge receipt of the webhook."
          }
        }
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}
```