Skip to main content
POST
CLI
Minimo sends the events you subscribe to to this URL, signed with your secret.
While an active webhook subscribes to whatsapp.message.received, every WhatsApp number of your workspace is answered by your bot: Minimo’s own AI assistant stops replying on them. See One responder per number.

Use Cases

  • Connect your bot: subscribe to whatsapp.message.received and answer with Send a Message
  • Know what was delivered: add whatsapp.message.status to learn when a message is delivered, read or failed

The secret

secret is required (at least 16 characters). Minimo signs every delivery with it (X-Minimo-Signature) and never returns it: hasSecret only tells you one is set. Store it when you register; to change it, use Update Webhook. See Verify the signature.

Permissions

The API key needs the WhatsApp permission.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
name
string
required

A label for you.

Minimum string length: 1
url
string
required

Your HTTPS endpoint that receives the events.

secret
string
required

Used to sign every delivery (X-Minimo-Signature). Never returned: store it.

Minimum string length: 16
events
enum<string>[]
required

whatsapp.message.received = a contact wrote to you. whatsapp.message.status = a message you sent was sent, delivered, read or failed.

Minimum array length: 1
Available options:
whatsapp.message.received,
whatsapp.message.status
method
enum<string>
default:POST
Available options:
POST,
GET
headers
object[]

Static headers to send on every delivery, for example an auth header for your endpoint.

Response

The new webhook

data
object

A webhook registration. The secret is never returned: hasSecret tells you one is set.