FlowFast External Webhooks

You can use webhooks to notify your app or web application about certain events occured in spaces with activated external webhook. For example, you want to alert your application when card in particular space is updated or a comment to card is added. By using webhooks you can make fewer API calls and make sure your apps are more efficient.

Webhook installation

Creating a webhook is a two-step process. First you have to activate webhook in FlowFast(you can set up different webhooks for each space), and after that you have to set up your server to receive and manage the payload.To activate webhook in particular space in FlowFast go tospace setting,chooseexternal webhooksin Menu and type your URL, that will receive the webhookPOSTrequests. To register a webhook click create. By default newly created webhook is active, but you can always turn it off in menu.
Once installed, the webhook notification will be triggered each time available events occur. This notification contains a JSON payload.
The structure is simple and clear:
  • add events
{
    "event": action,
    "data": {
      "author": {...},
      ... // model keys, see examples below
    },
}
  • update events
{
    "event": action,
    "data": {
      "old": {...},
      "changes": {...},
      "author": {...}
    }
}
  • remove events
{
    "event": action,
    "data": {
      "author": {...},
      ... // model keys, see examples below
    }
}

Delivery and retries

Each queued delivery includes a Webhook-Id header. Automatic retries of that delivery use the same ID. If the source event is queued again independently, it receives a new ID. The ID of a card or another entity in the payload is not a delivery ID.
A 2xx response acknowledges delivery. Transient connection errors, timeouts, and HTTP 408, 429, 500, 502, 503, and 504 responses are retried with exponential backoff. Other HTTP errors are final failures. Delivery can still fail after all attempts. A timeout does not prove that the receiver did not process the request.
Receivers should store Webhook-Id in a durable store with a unique constraint and process each ID only once. Save the ID together with the business change, or with a queued task, in one transaction. Return a 2xx response when an already accepted ID is received again. Keep IDs for at least as long as deliveries may be retried.
So far we support actions belonging to Spaces, Boards, Cards, Blocks, Comments, Time Logs, Tags, Files.
logo
FlowFast
If you have any questions or need help with integration feel free to write us at support@flowfast.io