Overview
Webhooks (or HTTP callbacks) are a common way for web applications to trigger an action on an external platform. Mindflow supports webhooks so that tools like ticketing systems or communication tools can emit alerts and trigger Mindflow playbook execution.
Webhooks are received on a unique URL based on the playbook you want to trigger.
Webhooks are active by default on any playbook.
Webhooks are protected by an API secret key included in an HTTP header or an HTTP query parameter.
Supported methods are GET, POST, and PUT.
Guide
Webhook configuration is specific to each tool. They can generally be found in their own documentation.
You may also find instructions for some popular tools under 🌐 Integrations.
All HTTP requests are under authorization thanks to the use of an API secret. Please ask our support to get yours (it’ll be available on the Mindflow platform later).
Authorization with header
Address:
https://webhook-{tenantId}.mindflow.dev/playbooks/{playbookId}/steps/start/run-asyncHTTP header:
X-API-Key: {apikey}
Authorization with query parameter
⚠️
This type of authorization is less secure. However, many tools (like Atlassian Jira) still use this approach. Please note the endpoint is slightly different than with header, adding a -qp suffix to the address.
Address:
https://webhook-{tenantId}.mindflow.dev/playbooks/{playbookId}/steps/start/run-async-qp?apikey={apikey}Query parameter:
apikey={apikey}
Known limitations
These are limitations that may be addressed in the future:
API secret key is unique for all playbooks.