Webhook

An example of a server request for a webhook address passed in the hook parameter of requests to send messages.

URI: /api/json.php

All requests to API are sent in JSON format using the POST method.

Header parameters

Requests must contain header Content-Type: application/json and X-Signature, otherwise, the request will be considered invalid even if it has valid JSON.

X-Signature

The X-Signature header is passed by concatenating a JSON string and an API-key.
Example: X-Signature: sha256(json_body + api_key)

Request parameters

idnumberrequired Unique message identifier in the client system

msg_idnumber Message identifier assigned by the gateway

typestringrequired Request type

statusstring Message status

datetimestring Date and time of receipt of the response Format: YYYYY-MM-DDThh:mm:ss±hh:mm

replieslist[object] List of replies to the message ⚠️ Available only in Viber 2 Way datetimestring Date and time of receipt of the response Format: YYYYY-MM-DDThh:mm:ss±hh:mm messagestring Text of message mediaobject Object containing information about the media file attached to the message urlstring Link to media file filenamestring Media file name filesizenumber Media file size

Request example

Default

{
    "id": 100500,
    "msg_id": 123456789,
    "type": "viber",
    "status": "READ",
    "datetime": "2024-01-31T12:34:00+02:00"
}

Viber 2 Way

{
    "id": 100500,
    "msg_id": 123456789,
    "type": "viber",
    "status": "READ",
    "datetime": "2024-01-31T12:34:00+02:00",
    "replies": [
        {
            "datetime": "2024-01-31T12:34:00+02:00",
            "message": "Please wait"
        },
        {
            "datetime": "2024-01-31T12:34:01+02:00",
            "media": {
                "url": "https://url.com/home/vibermedia/",
                "filename": "invoice.pdf",
                "filesize": 67983
            }
        },
        {
            "datetime": "2024-01-31T12:34:02+02:00",
            "message": "Correct invoice",
            "media": {
                "url": "https://url.com/home/vibermedia/",
                "filename": "invoice.pdf",
                "filesize": 68934
            }
        }
    ]
}

Response parameters

You will receive code 200 in response.

Response example

Successful

HTTP Status Code: 200
Content Type: JSON application/json