Sign in

Create External Provider

POST https://{organization}.myguper.com/api/sender/external-provider

Registers an External Provider (webhook) for the organization. The Sender will POST messages to the configured URL whenever a template that points to this provider is dispatched.

The endpoint resolves the provider_source of type external automatically — clients only need to send name, default and the data block describing the webhook URL and authentication.

Auth methods

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

See Webhook payload for the request shape your endpoint should expect.

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` for endpoints that accept a JSON body.

Request body

Content-Type: application/json

{
    "name": "Meu Webhook CRM",
    "default": false,
    "data": {
        "url": "https://api.meucrm.com/webhooks/messages",
        "authMethod": "bearer",
        "authToken": "sk-abc123..."
    }
}

Responses

{
    "id": 42,
    "name": "Meu Webhook CRM",
    "default": false,
    "data": {
        "url": "https://api.meucrm.com/webhooks/messages",
        "authMethod": "bearer",
        "authToken": "sk-abc123..."
    }
}

Related

Copied to clipboard