Skip to main content

REST hooks for Zapier, Make and n8n

A REST hook lets an automation platform ask MonoPbx for events one trigger at a time. When someone turns a Zap, scenario or workflow on, the platform subscribes its own address to one event. When they turn it off, it unsubscribes. MonoPbx then sends each matching event to that address as a signed POST.

A subscription is an outbound webhook endpoint for one event type, so signing, retries, the outbound address guard and the rules about who may receive which event are the same. It counts towards the limit of webhook endpoints of your company.

Calls​

All calls use an API key or a user token. See API getting started.

CallPermission
POST /api/v1/hooks/subscriptionsintegrations:write
GET /api/v1/hooks/subscriptionsintegrations:read
DELETE /api/v1/hooks/subscriptions/{id}integrations:write

Subscribe with:

{ "target_url": "https://hooks.zapier.com/hooks/standard/123/abc", "event": "call.ended", "source": "zapier" }
  • target_url must be a public https address. Loopback, private-network and internal names are refused.
  • event is one event type or one topic pattern such as call.*. It must be an event the key may receive for the whole company, with the permission listed in Outbound webhooks. Otherwise the answer is 400.
  • source is optional (zapier, make, n8n) and tells subscriptions apart.

The answer is 201 with the subscription id and a Standard Webhooks signing secret, shown once. Keep the id to unsubscribe. The list never shows secrets and does not include endpoints created in the console. Deleting a subscription also removes its waiting deliveries; an unknown id, another company's id or a console endpoint answers 404.

Receiving events​

Each delivery is a JSON envelope {id, type, occurred_at, data} with the Standard Webhooks headers described in Outbound webhooks. Use id to ignore duplicates.

Zapier, Make and n8n​

Use the platform's webhook trigger to subscribe with these calls, and the public API for actions. You can also receive the same events at a webhook endpoint.