Everpro Chat Open API contains specification for public api provided by Everpro for partners. It describes how to communications between your service and Everpro RESTful Web Service.
The diagram below describes the overview flow of the Everpro Chat Open API. Before accessing the API, partners need to register their account and generate the client secret and client key.

The diagram below explains how the interaction flows between the Partner system and the Everpro system to send message with template. Partner can skip the Get Device List and Get Message Template List steps if they already know the device phone number and message template key that will be used to send message.

To keep the partner's system synchronized with events occurring in Everpro Chat, partner can configure a callback URL in the Everpro Chat Dashboard page API/App Integration.
Once configured, Everpro will send HTTP POST requests to partner's callback URL whenever when specific events occur. Currently, the supported events are:
Please refer to section Callback for more details about the callback data for each event.
A WhatsApp Flow is a form that opens inside the chat of the customer. Partner can send a flow to a customer.
GET /chat/v1/flows to get the flows of a WhatsApp number. Only flows that are published can be sent. If the flows are not up to date, call POST /chat/v1/flows/sync first.POST /chat/v1/message/interactive/send with one button of type flow and the flow_id from step 1. A flow is sent as a free-form message, so the customer must have an active 24-hour session with the number.The send API checks in this order, and returns the first error it finds:
404, flow not found for this WABA).422, flow is not published).400, the same session error as any other interactive message).Every flow Everpro sends has a flow_token. It is returned in the response of the send API.
The token is made by Everpro, a partner can not set it. Meta passes it along without changing it.
The flow_token is a JWT signed with HS256. It holds ids only, no phone number, and it is new for every send, so two sends of the same flow to the same customer never share a token.
{
"owner_id": "0697a9f0-3c11-7d2e-8000-5b6c7d8e9f01",
"room_id": "0697b2c3-4d5e-7f60-8000-1a2b3c4d5e6f",
"meta_flow_id": "1234567890123456",
"jti": "0697c1d2-7f00-7abc-8000-1b2c3d4e5f60",
"iat": 1792040700
}
| Claim | Description |
|---|---|
owner_id |
Your Everpro user id. |
room_id |
The chat room of the customer. It is the room_id of the send API response and of the callbacks. |
meta_flow_id |
The Meta flow id, the flow_id of GET /chat/v1/flows. |
jti |
A unique id of this send. |
iat |
The time the token was made, in Unix seconds. |
The header kid says which key signed the token:
kid |
Signed with | Can you verify it? |
|---|---|---|
client |
Your callback key (API/App Integration page in the Everpro Chat Dashboard). Used when you have a callback key |
Yes. Use the callback key |
| Your merchant code | An Everpro key. Used when you have no callback key, or for a flow built in Everpro Chat | No. You can read the claims, but not check the signature |
A token is signed with the callback key you had when it was sent. When you change the callback key, new tokens use the new key and earlier tokens stay signed with the old key.
If your flow has a data endpoint, Meta sends the flow_token to it on every request. Use the claims to know which room and which send the request is for.
To know the customer behind a room_id, call GET /chat/v1/room/{id}.
package main
import (
"crypto/hmac"
"crypto/sha256"
"encoding/base64"
"encoding/json"
"errors"
"strings"
)
// VerifyFlowToken checks a flow token signed with the callback key (kid "client")
// and returns its claims.
func VerifyFlowToken(token, callbackKey string) (map[string]interface{}, error) {
parts := strings.Split(token, ".")
if len(parts) != 3 {
return nil, errors.New("invalid token")
}
headerJSON, err := base64.RawURLEncoding.DecodeString(parts[0])
if err != nil {
return nil, err
}
var header struct {
Alg string `json:"alg"`
Kid string `json:"kid"`
}
if err := json.Unmarshal(headerJSON, &header); err != nil {
return nil, err
}
if header.Alg != "HS256" || header.Kid != "client" {
return nil, errors.New("token is not signed with the callback key")
}
mac := hmac.New(sha256.New, []byte(callbackKey))
mac.Write([]byte(parts[0] + "." + parts[1]))
signature, err := base64.RawURLEncoding.DecodeString(parts[2])
if err != nil {
return nil, err
}
if !hmac.Equal(signature, mac.Sum(nil)) {
return nil, errors.New("invalid signature")
}
claimsJSON, err := base64.RawURLEncoding.DecodeString(parts[1])
if err != nil {
return nil, err
}
var claims map[string]interface{}
if err := json.Unmarshal(claimsJSON, &claims); err != nil {
return nil, err
}
return claims, nil
}
To ensure the authenticity and integrity of callback requests, every callback includes an x-everpro-signature header.
The signature is generated using the HMAC SHA256 algorithm with the raw request body and the partner's callback key.
The callback key can be found in the Everpro Chat Dashboard page API/App Integration once the callback URL is configured.
Signature Formula:
HMAC_SHA256(raw_request_body, callback_key)
We strongly recommend validating the signature before processing any callback request. If the generated signature does not match the value received in the x-everpro-signature header, the request should be rejected.
func ValidateSignature(
payload []byte,
secretKey string,
receivedSignature string,
) bool {
hash := hmac.New(sha256.New, []byte(secretKey))
hash.Write(payload)
expectedSignature := hex.EncodeToString(hash.Sum(nil))
return hmac.Equal(
[]byte(expectedSignature),
[]byte(receivedSignature),
)
}
func callbackHandler(w http.ResponseWriter, r *http.Request) {
body, err := io.ReadAll(r.Body)
if err != nil {
http.Error(w, "invalid request body", http.StatusBadRequest)
return
}
signature := r.Header.Get("x-everpro-signature")
if !ValidateSignature(body, secretKey, signature) {
http.Error(w, "invalid signature", http.StatusUnauthorized)
return
}
// Process callback event
w.WriteHeader(http.StatusOK)
}
The callback payload may contain personal data and other sensitive information. To protect this data during transmission and prevent unauthorized access,
the callback payload is encrypted before being sent to partners. The encrypted payload uses AES-256-GCM, which provides both confidentiality and integrity protection.
The partner is responsible for decrypting the payload using the encryption key. The encryption key can be found in the Everpro Chat Dashboard page API/App Integration once the callback URL is configured.
Each callback payload contains a set of standard fields that provide information about the callback event.
JSON
{
"id": "<request id>",
"user_id": "<user id>",
"timestamp": "<timestamp>",
"event": "<event name>",
"data": {
"room_id": "<room id>",
"customer_phone_number": "<customer phone number>",
"device_phone_number": "<device phone number>",
...
},
"encrypted_data": "<encrypted data>"
}
Standard Fields
| Field | Type | Description |
|---|---|---|
id |
String | Unique identifier for the callback event. |
user_id |
String | Identifier of the user associated with the event. |
timestamp |
String | The timestamp when the event occurred, in ISO 8601 format. |
event |
String | The name of the callback event. |
data |
Object | The callback data in plain format. This field is deprecated and will be removed in the future. |
encrypted_data |
String | The callback data encrypted using AES-256-GCM. |
Encrypted_data
The encrypted_data field contains the encrypted version of the callback data. After successfully decrypting the encrypted_data field, the resulting payload will follow the data structure defined for the corresponding event.
Please refer to section Callback for more details about the callback data for each event. To support a smooth transition to encrypted callback data, the payload format will be introduced in two phases.
JSON
{
"id": "<request id>",
"user_id": "<user id>",
"timestamp": "<timestamp>",
"event": "<event name>",
"encrypted_data": "<encrypted data>"
}
Existing Callback Events
For existing callback events, both data and encrypted_data will initially be provided:
JSON
{
"id": "<request id>",
"user_id": "<user id>",
"timestamp": "<timestamp>",
"event": "<event name>",
"data": {
"room_id": "<room id>",
"customer_phone_number": "<customer phone number>",
"device_phone_number": "<device phone number>",
...
},
"encrypted_data": "<encrypted data>"
}
The partner must decrypt the encrypted_data field using the AES-256-GCM encryption key provided by our system. The following example demonstrates how to decrypt the payload using Go:
package main
import (
"crypto/aes"
"crypto/cipher"
"crypto/sha256"
"encoding/base64"
"errors"
)
// DecryptAES256GCM decrypts a value produced by EncryptAES256GCM.
func DecryptAES256GCM(encryptedData, encryptionKey string) ([]byte, error) {
key := sha256.Sum256([]byte(encryptionKey))
block, err := aes.NewCipher(key[:])
if err != nil {
return nil, err
}
gcm, err := cipher.NewGCM(block)
if err != nil {
return nil, err
}
data, err := base64.StdEncoding.DecodeString(encryptedData)
if err != nil {
return nil, err
}
nonceSize := gcm.NonceSize()
if len(data) < nonceSize {
return nil, errors.New("ciphertext too short")
}
nonce, cipherText := data[:nonceSize], data[nonceSize:]
decryptedData, err := gcm.Open(nil, nonce, cipherText, nil)
if err != nil {
return nil, err
}
return decryptedData, nil
}
package main
import (
"errors"
"fmt"
)
func main() {
encryptionKey := "<encryption key>"
encryptedData := "<encrypted data>"
// Decrypt
decryptedData, err := DecryptAES256GCM(encryptedData, encryptionKey)
if err != nil {
return
}
fmt.Printf("Decrypted Data: %s", string(decryptedData))
}
Your callback endpoint should return an HTTP 200 OK response after successfully processing the callback request.
Get Access Token v2
Request Body
| client_key required | string
|
| client_secret required | string
|
{- "client_key": "aBcDEaF8ugo4aWFfK6JEMXtK3LNq5BLS",
- "client_secret": "HRDbO8KL99xyyRVymkllku23xtpxU4vl"
}{- "data": {
- "expires": 86400,
- "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJtc2lzZG4iOiIiLCJuYW1lIjoiRVZFUk1PUyIsInVzZXJfY2F0ZWdvcnlfaWQiOjIwMCwiZXhwIjoxNjUwMzM1NDg3LCJ",
- "token_type": "Bearer"
}, - "message": "success create/get ...",
- "metadata": null,
- "request_id": "019564e5-8ab3-7bbe-98dc-164750ec045e",
- "status": "success",
- "status_code": 200,
- "timestamp": "2022-04-14T05:55:35.006Z"
}This endpoint returns the list of devices
| phone_number | string Device phone number |
const request = require('request'); const options = { method: 'GET', url: 'https://client-api-sandbox.everpro.id/chat/v1/device/list', qs: {phone_number: 'SOME_STRING_VALUE'}, headers: {Authorization: 'REPLACE_KEY_VALUE'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "data": [
- {
- "device_key": "oyey0yyVR",
- "device_name": "device 1",
- "is_active": true,
- "phone_number": "628100000000",
- "status": "otp_done"
}
], - "message": "success create/get ...",
- "metadata": {
- "page": 0,
- "page_size": 0,
- "total_data": 0,
- "total_page": 0
}, - "request_id": "019564e5-8ab3-7bbe-98dc-164750ec045e",
- "status": "success",
- "status_code": 200,
- "timestamp": "2022-04-14T05:55:35.006Z"
}This endpoint returns the list of chat divisions, including the number of agents per division
| search | string Filter by division name |
| page | integer Page |
| page_size | integer Page size |
| show_total_agent | boolean Include the total agent count per division |
| is_default | boolean Filter by default division status |
const request = require('request'); const options = { method: 'GET', url: 'https://client-api-sandbox.everpro.id/chat/v1/division', qs: { search: 'SOME_STRING_VALUE', page: 'SOME_INTEGER_VALUE', page_size: 'SOME_INTEGER_VALUE', show_total_agent: 'SOME_BOOLEAN_VALUE', is_default: 'SOME_BOOLEAN_VALUE' }, headers: {Authorization: 'REPLACE_KEY_VALUE'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "data": [
- {
- "id": "019564e5-8ab3-7bbe-98dc-164750ec045e",
- "is_default": true,
- "name": "device 1",
- "total_agent": 3
}
], - "message": "success create/get ...",
- "metadata": {
- "page": 0,
- "page_size": 0,
- "total_data": 0,
- "total_page": 0
}, - "request_id": "019564e5-8ab3-7bbe-98dc-164750ec045e",
- "status": "success",
- "status_code": 200,
- "timestamp": "2022-04-14T05:55:35.006Z"
}This endpoint returns the list of message templates
| name | string Message template name |
| category | string Message template category |
| status | string Message template status |
| template_key | string Message template key |
| device_phone_number | string Device phone number |
| page | integer Page |
| page_size | integer Page size |
| sort_by | string Sort by |
| sort_direction | string Sort direction |
const request = require('request'); const options = { method: 'GET', url: 'https://client-api-sandbox.everpro.id/chat/v1/message/template', qs: { name: 'SOME_STRING_VALUE', category: 'SOME_STRING_VALUE', status: 'SOME_STRING_VALUE', template_key: 'SOME_STRING_VALUE', device_phone_number: 'SOME_STRING_VALUE', page: 'SOME_INTEGER_VALUE', page_size: 'SOME_INTEGER_VALUE', sort_by: 'SOME_STRING_VALUE', sort_direction: 'SOME_STRING_VALUE' }, headers: {Authorization: 'REPLACE_KEY_VALUE'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "data": [
- {
- "category": "string",
- "details": [
- {
- "body": {
- "content": "string",
- "mapping_param": {
- "property1": "string",
- "property2": "string"
}, - "param_list": [
- "string"
]
}, - "buttons": [
- {
- "button_icon": "string",
- "index": 0,
- "mapping_param": {
- "property1": "string",
- "property2": "string"
}, - "param_list": [
- "string"
], - "properties": {
- "button_icon": "string",
- "country_code_name": "string",
- "example": [
- "string"
]
}, - "text": "string",
- "type": "string",
- "value": "string"
}
], - "cards": [
- {
- "body": {
- "content": "string",
- "mapping_param": {
- "property1": "string",
- "property2": "string"
}, - "param_list": [
- "string"
]
}, - "buttons": [
- {
- "button_icon": "string",
- "index": 0,
- "mapping_param": {
- "property1": null,
- "property2": null
}, - "param_list": [
- null
], - "properties": {
- "button_icon": null,
- "country_code_name": null,
- "example": [ ]
}, - "text": "string",
- "type": "string",
- "value": "string"
}
], - "header": {
- "content": "string",
- "mapping_param": {
- "property1": "string",
- "property2": "string"
}, - "param_list": [
- "string"
], - "type": "string"
}, - "index": 0
}
], - "footer": {
- "content": "string"
}, - "header": {
- "content": "string",
- "mapping_param": {
- "property1": "string",
- "property2": "string"
}, - "param_list": [
- "string"
], - "type": "string"
}, - "key": "string",
- "language": "string",
- "message_send_ttl_seconds": 0,
- "status": "string",
- "status_reason": "string"
}
], - "devices": [
- {
- "device_key": "oyey0yyVR",
- "device_name": "device 1",
- "is_active": true,
- "phone_number": "628100000000",
- "status": "otp_done"
}
], - "id": "string",
- "meta_created_at": "string",
- "meta_created_by_name": "string",
- "meta_updated_at": "string",
- "meta_updated_by_name": "string",
- "name": "string"
}
], - "message": "success create/get ...",
- "metadata": {
- "page": 0,
- "page_size": 0,
- "total_data": 0,
- "total_page": 0
}, - "request_id": "019564e5-8ab3-7bbe-98dc-164750ec045e",
- "status": "success",
- "status_code": 200,
- "timestamp": "2022-04-14T05:55:35.006Z"
}Sync message templates from the provider.
| X-Request-Id | string <uuid> Request id used for idempotency check |
Request Body
| template_name required | string Filter sync to templates matching this name. |
{- "template_name": "order_confirmation"
}{- "data": null,
- "message": "success create/get ...",
- "metadata": null,
- "request_id": "019564e5-8ab3-7bbe-98dc-164750ec045e",
- "status": "success",
- "status_code": 200,
- "timestamp": "2022-04-14T05:55:35.006Z"
}This endpoint sends a message using message template from a specific device to customer's phone number.
Request Body
object Template body's parameters mapping
| |
Array of objects Template buttons' parameters, keyed by button index | |
object Template cards' parameters mapping | |
| customer_bsuid | string Receiver BSUID (Meta business-portfolio external customer id) |
| customer_phone_number | string Receiver phone number |
| device_phone_number required | string Sender device phone number |
object Template header's parameters mapping | |
| template_key required | string Message template key |
{- "body_params": {
- "property1": "string",
- "property2": "string"
}, - "button_params": [
- {
- "index": "0",
- "parameters": [
- {
- "type": "text",
- "value": "chat?filter=yes"
}
]
}
], - "card_params": {
- "property1": {
- "body_params": {
- "property1": "string",
- "property2": "string"
}
}, - "property2": {
- "body_params": {
- "property1": "string",
- "property2": "string"
}
}
}, - "customer_bsuid": "ID.123456",
- "customer_phone_number": "string",
- "device_phone_number": "string",
- "header_params": {
- "property1": "string",
- "property2": "string"
}, - "template_key": "string"
}{- "message_status_id": "string",
- "reason": {
- "string": "string",
- "valid": true
}, - "status": "string"
}This endpoint sends a reply message from a specific device or room to customer's phone number.
| X-Request-Id | string <uuid> Request id used for idempotency check |
Request Body
object Audio message content | |
| customer_bsuid | string Receiver BSUID (Meta business-portfolio external customer id) |
| customer_phone_number | string <phone> Receiver phone number |
| device_phone_number | string <phone> Sender device phone number |
object Document message content | |
object Image message content | |
| quoted_message_id | string <uuid> Message id that is being replied to |
| room_id | string <uuid> Room id. Required if device_phone_number and (customer_phone_number or customer_bsuid) are not provided |
object Text message content | |
| type required | string Message type Values: text, audio, document, video, image |
object Video message content |
{- "customer_bsuid": "ID.123456",
- "customer_phone_number": "6281232323235",
- "device_phone_number": "6281232323233",
- "document": {
- "caption": "Document caption",
- "filename": "document.pdf",
}, - "image": {
- "caption": "Image caption",
- "filename": "image.png",
}, - "quoted_message_id": "c1f1ed8e-d4b9-4e4d-b1c1-04ddab94e26d",
- "room_id": "05451321-18e1-4bfa-aa22-dfd0080cc120",
- "text": {
- "body": "Hello World"
}, - "type": "text",
- "video": {
- "caption": "Video caption",
- "filename": "video.mp4",
}
}{- "created_at": "2026-08-10T08:51:22.000Z",
- "customer_conversation_id": "06a71a04-609a-7ede-8000-8423708109be",
- "message_id": "b1d8c9c6-3e2f-4d5a-8b7c-1a2b3c4d5e6f",
- "room_id": "5f391b94-108b-48f2-b145-9cdc23608aa4",
- "session_id": "06a7a7e6-806a-79ed-8000-e625a2fb291f",
- "status": "sending"
}This endpoint sends an interactive message from a specific device or room to customer's phone number.
Button types: reply (1-10 buttons), cta_url (one button) and flow (one WhatsApp Flow button). Types cannot be mixed in one message.
A flow message is sent as a free-form message, so it needs an active 24-hour session with the customer. The checks run in this order: the flow belongs to the WABA of the device (404), the flow is published (422), the session is active (the same session error as any other interactive message).
The response of a flow message carries a flow_token (JWT). Check its signature with your webhook callback_key when its header kid is client.
| X-Request-Id | string <uuid> Request id used for idempotency check |
Request Body
required | object Interactive message body |
required | Array of objects [ 1 .. 10 ] items Interactive message buttons |
| customer_bsuid | string Receiver BSUID (Meta business-portfolio external customer id) |
| customer_phone_number | string <phone> Receiver phone number |
| device_phone_number | string <phone> Sender device phone number |
object Interactive message footer | |
object Interactive message header | |
| room_id | string <uuid> Room id. Required if device_phone_number and (customer_phone_number or customer_bsuid) are not provided |
{- "body": {
- "text": "Body text"
}, - "buttons": [
- {
- "flow_action_payload": {
- "data": { },
- "screen": "DATA_DIRI"
}, - "flow_id": "1234567890123456",
- "id": "button-1",
- "text": "Yes",
- "type": "reply",
}
], - "customer_bsuid": "ID.123456",
- "customer_phone_number": "6281232323235",
- "device_phone_number": "6281232323233",
- "footer": {
- "text": "Footer text"
}, - "header": {
- "text": "Header text",
- "type": "text",
}, - "room_id": "05451321-18e1-4bfa-aa22-dfd0080cc120"
}{- "created_at": "2026-08-10T08:51:22.000Z",
- "customer_conversation_id": "06a71a04-609a-7ede-8000-8423708109be",
- "flow_token": "eyJhbGciOiJIUzI1NiIsImtpZCI6ImNsaWVudCJ9.eyJvd25lcl9pZCI6Ii4uLiJ9.c2lnbmF0dXJl",
- "message_id": "b1d8c9c6-3e2f-4d5a-8b7c-1a2b3c4d5e6f",
- "room_id": "5f391b94-108b-48f2-b145-9cdc23608aa4",
- "session_id": "06a7a7e6-806a-79ed-8000-e625a2fb291f",
- "status": "sending"
}This endpoint starts a sync of the WhatsApp flows of the account's official numbers. Every WABA is synced in the background, so the answer says what was started, not what was found; read the result with the get flow list endpoint. The account can start a sync once every 30 minutes, shared with the dashboard: on cooldown the answer is a 429 with data.retry_after_seconds.
Request Body
| device_phone_numbers | Array of strings Device phone numbers to sync. |
| is_all | boolean Sync every WhatsApp official number of the account. |
{- "device_phone_numbers": [
- "6281200000000"
], - "is_all": false
}{- "data": {
- "results": [
- {
- "device_phone_numbers": [
- "6281200000000"
], - "error": "meta request failed",
- "last_synced_at": "2026-10-18T16:00:12.000Z",
- "started_at": "2026-10-19T03:00:00.000Z",
- "status": "in_progress",
- "waba_id": "1029384756"
}
], - "retry_after_seconds": 1200,
- "status": "accepted"
}, - "message": "success create/get ...",
- "metadata": null,
- "request_id": "019564e5-8ab3-7bbe-98dc-164750ec045e",
- "status": "success",
- "status_code": 200,
- "timestamp": "2022-04-14T05:55:35.006Z"
}This endpoint returns the list of WhatsApp flows owned by a device
| device_phone_number required | string Device phone number |
| name | string Filter by flow name |
| status | string Flow status |
| page | integer Page |
| page_size | integer Page size |
| sort_by | string Sort by |
| sort_direction | string Sort direction |
const request = require('request'); const options = { method: 'GET', url: 'https://client-api-sandbox.everpro.id/chat/v1/flows', qs: { device_phone_number: 'SOME_STRING_VALUE', name: 'SOME_STRING_VALUE', status: 'SOME_STRING_VALUE', page: 'SOME_INTEGER_VALUE', page_size: 'SOME_INTEGER_VALUE', sort_by: 'SOME_STRING_VALUE', sort_direction: 'SOME_STRING_VALUE' }, headers: {Authorization: 'REPLACE_KEY_VALUE'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "data": [
- {
- "categories": [
- "SIGN_UP"
], - "flow_id": "1234567890123456",
- "last_synced_at": "2026-08-10T08:51:22.000Z",
- "name": "onboarding_flow",
- "status": "published"
}
], - "message": "success create/get ...",
- "metadata": {
- "page": 0,
- "page_size": 0,
- "total_data": 0,
- "total_page": 0
}, - "request_id": "019564e5-8ab3-7bbe-98dc-164750ec045e",
- "status": "success",
- "status_code": 200,
- "timestamp": "2022-04-14T05:55:35.006Z"
}This endpoint returns the detail of a chat room, including the customer it belongs to and the conversation that is currently open
| id required | string <uuid> Room id |
const request = require('request'); const options = { method: 'GET', url: 'https://client-api-sandbox.everpro.id/chat/v1/room/%7Bid%7D', headers: {Authorization: 'REPLACE_KEY_VALUE'} }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
{- "data": {
- "conversation_status": "open",
- "customer_bsuid": "ID.1234567890",
- "customer_conversation_id": "0697b2c3-4d5e-7f60-8000-1a2b3c4d5e70",
- "customer_name": "Budi Santoso",
- "customer_phone_number": "6281300000000",
- "device_phone_number": "6281200000000",
- "last_message_at": "2026-10-14T03:04:58.000Z",
- "room_id": "0697b2c3-4d5e-7f60-8000-1a2b3c4d5e6f"
}, - "message": "success create/get ...",
- "metadata": null,
- "request_id": "019564e5-8ab3-7bbe-98dc-164750ec045e",
- "status": "success",
- "status_code": 200,
- "timestamp": "2022-04-14T05:55:35.006Z"
}This endpoint assigns a chat room to a specific division.
| id required | string <uuid> Room id |
| X-Request-Id | string <uuid> Request id used for idempotency check |
Request Body
| division_id required | string <uuid> Division id the room should be assigned to |
| reason | string Reason for the assignment |
{- "division_id": "3d0a8c9e-4f1b-4a6c-9d2e-5f7b8a9c0d1e",
- "reason": "manual reassignment"
}{- "data": null,
- "message": "success create/get ...",
- "metadata": null,
- "request_id": "019564e5-8ab3-7bbe-98dc-164750ec045e",
- "status": "success",
- "status_code": 200,
- "timestamp": "2022-04-14T05:55:35.006Z"
}Broadcast Delivery Status Callback is a mechanism to let client know when a broadcast message status was updated.
| x-everpro-signature required | string
|
| user-agent required | string
|
Request Body
| id | string
|
| user_id | string
|
| timestamp | string
|
| event | string
|
object
| |
| encrypted_data | string
|
{- "id": "5e1c69e4-8458-414d-8680-058fcad6a3cc",
- "user_id": "6aed6767-2b40-4526-bf8b-4221b9bd9b02",
- "timestamp": "2025-10-15T10:30:00.000Z",
- "event": "broadcast_delivery_status",
- "data": {
- "message_status_id": "56b3197c-acef-46f8-9367-79dee74c2a95",
- "broadcast_name": "",
- "customer_phone_number": "6281100000",
- "customer_bsuid": "ID.123456",
- "device_phone_number": "62811989719",
- "customer_conversation_id": "42c3197c-acef-46f8-9367-79dee74c2a95",
- "status": "success",
- "message_created_at": "2026-05-12T08:00:00.000Z",
- "message_status_updated_at": "2026-05-12T08:00:00.000Z"
}, - "encrypted_data": "string"
}First Inbound Message Callback is a mechanism to let client know when a first inbound or customer initiated message was received.
| x-everpro-signature required | string
|
| user-agent required | string
|
Request Body
| id | string
|
| user_id | string
|
| timestamp | string
|
| event | string
|
object
| |
| encrypted_data | string
|
{- "id": "5e1c69e4-8458-414d-8680-058fcad6a3cc",
- "user_id": "6aed6767-2b40-4526-bf8b-4221b9bd9b02",
- "timestamp": "2025-10-15T10:30:00.000Z",
- "event": "first_inbound_message",
- "data": {
- "room_id": "56b3197c-acef-46f8-9367-79dee74c2a95",
- "customer_phone_number": "6281100000",
- "customer_bsuid": "ID.123456",
- "device_phone_number": "62811989719",
- "customer_conversation_id": "42c3197c-acef-46f8-9367-79dee74c2a95",
- "message_id": "a236b376-8522-454f-ae30-039e36b21776",
- "message_created_at": "2026-05-12T08:00:00.000Z"
}, - "encrypted_data": "string"
}First Reply By Agent Callback is a mechanism to let client know when agent replied to a message for the first time in an active conversation.
| x-everpro-signature required | string
|
| user-agent required | string
|
Request Body
| id | string
|
| user_id | string
|
| timestamp | string
|
| event | string
|
object
| |
| encrypted_data | string
|
{- "id": "5e1c69e4-8458-414d-8680-058fcad6a3cc",
- "user_id": "6aed6767-2b40-4526-bf8b-4221b9bd9b02",
- "timestamp": "2025-10-15T10:30:00.000Z",
- "event": "first_reply_by_agent",
- "data": {
- "room_id": "56b3197c-acef-46f8-9367-79dee74c2a95",
- "customer_phone_number": "6281100000",
- "customer_bsuid": "ID.123456",
- "device_phone_number": "62811989719",
- "customer_conversation_id": "42c3197c-acef-46f8-9367-79dee74c2a95",
- "message_id": "a236b376-8522-454f-ae30-039e36b21776",
- "actor_email": "agent1@xyz.com",
- "actor_name": "Agent 1",
- "actor_role": "agent",
- "replied_at": "2026-05-12T08:00:00.000Z"
}, - "encrypted_data": "string"
}Conversation Closed Callback is a mechanism to let client know when conversation is closed.
| x-everpro-signature required | string
|
| user-agent required | string
|
Request Body
| id | string
|
| user_id | string
|
| timestamp | string
|
| event | string
|
object
| |
| encrypted_data | string
|
{- "id": "5e1c69e4-8458-414d-8680-058fcad6a3cc",
- "user_id": "6aed6767-2b40-4526-bf8b-4221b9bd9b02",
- "timestamp": "2025-10-15T10:30:00.000Z",
- "event": "conversation_closed",
- "data": {
- "room_id": "56b3197c-acef-46f8-9367-79dee74c2a95",
- "customer_conversation_id": "42c3197c-acef-46f8-9367-79dee74c2a95",
- "customer_phone_number": "6281100000",
- "customer_bsuid": "ID.123456",
- "device_phone_number": "62811989719",
- "notes": "conversation done",
- "closed_at": "2026-05-12T08:00:00.000Z",
- "actor_name": "Agent 1",
- "actor_email": "agent1@xyz.com",
- "actor_role": "agent"
}, - "encrypted_data": "string"
}Inbound Message Callback is a mechanism to let client know when a message from customer was received.
This callback also carries the answers of a WhatsApp Flow submission. There is no separate event for it: it is the same inbound_message event, sent only when the inbound_message event is active and a webhook URL is set, and delivered in encrypted_data (AES-256-GCM) like any other inbound message.
For a flow submission, message_content_type is interactive and reply_data.type is flow_result. The answers are in reply_data.flow_result.
Notice: before this release, a flow submission had reply_data.type = nfm_reply with an empty id and title. It is now flow_result. If you check for nfm_reply, please switch to flow_result.
| x-everpro-signature required | string
|
| user-agent required | string
|
Request Body
| id | string
|
| user_id | string
|
| timestamp | string
|
| event | string
|
| encrypted_data | string
|
object
|
{- "id": "5e1c69e4-8458-414d-8680-058fcad6a3cc",
- "user_id": "6aed6767-2b40-4526-bf8b-4221b9bd9b02",
- "timestamp": "2025-10-15T10:30:00.000Z",
- "event": "inbound_message",
- "encrypted_data": "string",
- "data": {
- "room_id": "56b3197c-acef-46f8-9367-79dee74c2a95",
- "customer_conversation_id": "42c3197c-acef-46f8-9367-79dee74c2a95",
- "customer_phone_number": "6281100000",
- "customer_bsuid": "ID.123456",
- "device_phone_number": "62811989719",
- "message_id": "a236b376-8522-454f-ae30-039e36b21776",
- "message_created_at": "2026-05-12T08:00:00.000Z",
- "quoted_message_id": "56b3197c-acef-46f8-9367-79dee74c2a95",
- "message_content_type": "image",
- "text_content": "Hello, good morning.",
- "filename": "image.png",
- "reply_data": {
- "type": "button",
- "id": "019f8d07-1435-743b-bb06-5965f798221f",
- "title": "Yes",
- "flow_result": {
- "flow_id": "1234567890123456",
- "flow_name": "Pendaftaran Pasien",
- "flow_token": "eyJhbGciOiJIUzI1NiIsImtpZCI6ImNsaWVudCJ9...",
- "submitted_at": "2026-10-14T03:04:58.000Z",
- "response": {
- "nama_lengkap": "Budi Santoso",
- "poli": "umum"
}, - "screens": [
- {
- "index": 0,
- "title": "Data Diri",
- "fields": [
- {
- "index": 0,
- "label": "Nama lengkap",
- "value": "Budi Santoso"
}
]
}
]
}
}
}
}Agent Replies Callback is a mechanism to let client know when agent replied to a message in an active conversation.
| x-everpro-signature required | string
|
| user-agent required | string
|
Request Body
| id | string
|
| user_id | string
|
| timestamp | string
|
| event | string
|
| encrypted_data | string
|
object
|
{- "id": "5e1c69e4-8458-414d-8680-058fcad6a3cc",
- "user_id": "6aed6767-2b40-4526-bf8b-4221b9bd9b02",
- "timestamp": "2025-10-15T10:30:00.000Z",
- "event": "agent_replies",
- "encrypted_data": "string",
- "data": {
- "room_id": "56b3197c-acef-46f8-9367-79dee74c2a95",
- "customer_conversation_id": "42c3197c-acef-46f8-9367-79dee74c2a95",
- "customer_phone_number": "6281100000",
- "customer_bsuid": "ID.123456",
- "device_phone_number": "62811989719",
- "actor_email": "agent1@xyz.com",
- "actor_name": "Agent 1",
- "actor_role": "agent",
- "message_id": "a236b376-8522-454f-ae30-039e36b21776",
- "replied_at": "2026-05-12T08:00:00.000Z",
- "quoted_message_id": "56b3197c-acef-46f8-9367-79dee74c2a95",
- "message_content_type": "image",
- "text_content": "Hello, good morning.",
- "filename": "image.png",
- "template_key": "aBC123xyz",
- "status": "sent",
- "reason": "insufficient credit"
}
}System Event - Agent Assignment Callback is a mechanism to let client know when agent assignment process (assign, unassign, handover) was occured in an active conversation.
| x-everpro-signature required | string
|
| user-agent required | string
|
Request Body
| id | string
|
| user_id | string
|
| timestamp | string
|
| event | string
|
| encrypted_data | string
|
object
|
{- "id": "5e1c69e4-8458-414d-8680-058fcad6a3cc",
- "user_id": "6aed6767-2b40-4526-bf8b-4221b9bd9b02",
- "timestamp": "2025-10-15T10:30:00.000Z",
- "event": "system_event",
- "encrypted_data": "string",
- "data": {
- "room_id": "56b3197c-acef-46f8-9367-79dee74c2a95",
- "customer_conversation_id": "42c3197c-acef-46f8-9367-79dee74c2a95",
- "customer_phone_number": "6281100000",
- "customer_bsuid": "ID.123456",
- "device_phone_number": "62811989719",
- "event_type": "agent_assignment",
- "actor_email": "agent1@xyz.com",
- "actor_name": "Agent 1",
- "actor_role": "agent",
- "previous_agent_email": "agent1@xyz.com",
- "previous_agent_name": "Agent 1",
- "new_agent_email": "agent2@xyz.com",
- "new_agent_name": "Agent 2",
- "division_name": "Agent 2"
}
}System Event - Message Delivery Status Callback is a mechanism to let client know when the delivery status of a message sent to a customer was updated.
This callback is sent under the system_event event, so a client subscribed to system_event receives it. Tell it apart from other system events by data.event_type = message_delivery_status.
Which messages. Every outbound message, template messages included, sent by an agent (including an agent with the supervisor role) or the owner. Messages from the customer, AI agents, bots and system messages never get this callback. Everpro sends a configured subset of these sender types.
Which statuses. delivered, read, failed and dropped_by_meta. Everpro sends a configured subset of these statuses. This callback is not only sent when a message fails: always read status first.
Template messages also keep the Broadcast Delivery Status Callback (broadcast_delivery_status). A client subscribed to both events receives both for a template message.
| x-everpro-signature required | string
|
| user-agent required | string
|
Request Body
| id | string
|
| user_id | string
|
| timestamp | string
|
| event | string
|
| encrypted_data | string
|
object
|
{- "id": "5e1c69e4-8458-414d-8680-058fcad6a3cc",
- "user_id": "6aed6767-2b40-4526-bf8b-4221b9bd9b02",
- "timestamp": "2025-10-15T10:30:00.000Z",
- "event": "system_event",
- "encrypted_data": "string",
- "data": {
- "room_id": "56b3197c-acef-46f8-9367-79dee74c2a95",
- "customer_conversation_id": "42c3197c-acef-46f8-9367-79dee74c2a95",
- "customer_phone_number": "6281100000",
- "customer_bsuid": "ID.123456",
- "device_phone_number": "62811989719",
- "event_type": "message_delivery_status",
- "actor_email": "agent1@xyz.com",
- "actor_name": "Agent 1",
- "actor_role": "agent",
- "message_id": "a236b376-8522-454f-ae30-039e36b21776",
- "meta_created_at": "2026-05-12T08:00:00.000Z",
- "message_status_updated_at": "2026-05-12T08:05:00.000Z",
- "quoted_message_id": "56b3197c-acef-46f8-9367-79dee74c2a95",
- "message_content_type": "image",
- "text_content": "Hello, good morning.",
- "filename": "image.png",
- "template_key": "aBC123xyz",
- "status": "delivered",
- "reason": "insufficient credit"
}
}