Skip to main content
WEBHOOK
message-received
{
  "event": "message_received",
  "fromNumber": "+14155551234",
  "toNumber": "+12025559999",
  "body": "Yes, that time works for me",
  "organizationId": "<string>",
  "agentId": "<string>",
  "conversationId": "<string>",
  "messageSid": "<string>"
}
{
  "received": true
}

Authorizations

​
x-api-key
string
header
required

API key for authentication. Generate API keys from the RevRing dashboard.

Body

application/json
​
event
string
required
Example:

"message_received"

​
fromNumber
string
required

The contact's number (E.164)

Example:

"+14155551234"

​
toNumber
string
required

Your number that received the text (E.164)

Example:

"+12025559999"

​
body
string
required

The text content of the incoming message

Example:

"Yes, that time works for me"

​
organizationId
string

Your organization ID

​
agentId
string

The agent that owns the number that received the text

​
conversationId
string

RevRing's id for the thread with this contact; use it with the messages log to read the full conversation

​
messageSid
string

Your provider's id for the inbound message

Response

200 - application/json

Acknowledge receipt. RevRing does not require a response body and does not retry.

​
received
boolean
Example:

true