Sign in

Webhook payload — full example

POST https://{organization}.myguper.comhttps://your-server.example.com/your-webhook

Reference only — this page documents the request that Sender sends to the URL you registered in Create external provider. You do not call this endpoint; you implement it.

Authentication

The Authorization (or X-API-Key) header is built from the data.authMethod/data.authToken you saved on the provider:

authMethod Header
bearer Authorization: Bearer {authToken}
basic Authorization: Basic base64(authUsername:authPassword)
apikey X-API-Key: {authToken}
none No auth header is sent

Expected response

HTTP status Sender behaviour
2xx Success — message marked as done.
4xx Permanent error — no retry.
5xx Transient error — retried.
Timeout Transient error — retried.

Try-it values populated from environment ACME (Demo)


Authentication

Token

Send your user token in the x-guper-authorization header.

Headers

Name Type Description
x-guper-authorization * string User token issued by Guper.
Content-Type * string Always `application/json`.
Authorization string Set when `data.authMethod` is `bearer` or `basic`. See the table above.
X-API-Key string Set when `data.authMethod` is `apikey`.
User-Agent * string Identifies the Sender service making the call.

Request body

Content-Type: application/json

{
    "event": "message.send",
    "timestamp": "2026-02-26T14:30:00Z",
    "organization": "xpto",
    "message": {
        "id": "12345",
        "sequence": "welcome",
        "slug": "welcome_email",
        "subject": "Olá Joao, bem-vindo!",
        "body": "Seu cadastro foi confirmado. Aproveite seu cashback de R$ 50,00.",
        "destination": {
            "name": "Joao Silva",
            "email": "joao@email.com",
            "cellphone": "+5511999999999",
            "countryCallingCode": "55"
        }
    },
    "variables": {
        "client": {
            "name": "Joao Silva",
            "email": "joao@email.com",
            "cellphone": "11999999999"
        },
        "order": {
            "id": 123,
            "total": 5000,
            "date": "2026-02-26 14:30:00"
        },
        "reward": {
            "name": "Cashback",
            "value": 5000
        },
        "organization": {
            "name": "Loja XYZ",
            "currency": "BRL",
            "language": "pt_BR"
        }
    }
}

Responses

{ "received": true }

Related

Copied to clipboard