Webhooks
Subscribe to real-time event notifications via webhooks. Create subscriptions that send HTTP POST requests to your endpoints when events occur โ such as ingestion tasks completing, metrics becoming available, or errors being raised.
โถUse cases
- Event-driven pipelines โ trigger downstream processing automatically when ingestion or metrics tasks complete
- Monitoring and alerting โ receive immediate notification of failures without polling
- Integration โ push FM API events into your existing systems (message queues, Slack, dashboards, etc.)
โถEndpoints
| Method | Path | Description |
|---|---|---|
| GET | /webhooks | List all webhook subscriptions |
| POST | /webhooks | Create a new webhook subscription |
| GET | /webhooks/:id | Get a specific webhook |
| PATCH | /webhooks/:id | Update a webhook (URL, events, active status) |
| DELETE | /webhooks/:id | Delete a webhook subscription |
| POST | /webhooks/:id/verify | Send a verification ping to the webhook URL |
| POST | /webhooks/:id/rotate-secret | Rotate the signing secret |
โถSecurity
Every webhook delivery is signed with an HMAC secret. Use the signing secret to verify that incoming requests to your endpoint genuinely originated from the FM API. Rotate the secret periodically using the rotate endpoint.
Required scope:
webhooks:readfor viewing,webhooks:writefor creating, updating, and deleting