Skip to content

Webhook scenarios

Common Ways to Use Webhooks

Webhooks send data automatically from Tallyfy to other systems when certain events happen. Here are the main events that can trigger a webhook:

Trigger: When a process is launched

You can set up a webhook at the template level. This webhook sends a notification immediately when someone launches a new process from that template, even before any tasks are done.

  • Use Case: Track new process starts in real-time (e.g., log every new client onboarding started in a spreadsheet or database).

Trigger: When a specific task is completed

You can set up a webhook on a specific step within a template. This webhook sends a notification only when that particular task is completed.

  • Use Case: Trigger follow-up actions in other systems when a key milestone is reached (e.g., when “Contract Signed” task is completed, send data to the finance system).

Video examples

These videos show practical ways to use webhooks, often with a middleware tool like Zapier:

  • Send Task Data to a Spreadsheet Shows how to automatically add form answers from a Tallyfy task to rows in a spreadsheet.

  • Start a New Process When a Task Finishes Shows how completing one task can automatically launch a different Tallyfy process.

  • Send Form Data from Multiple Steps Demonstrates sending data collected across several steps to another service.

  • Send an Email When a Task Finishes Shows how to trigger a custom email notification upon task completion.

Webhook payload data

Webhooks send detailed information in JSON format. You can see an example of the data structure here:

📌 Webhook-Sample.json

Webhook Payload Structure

The JSON payload sent by the webhook contains detailed information about the event. Key sections include:

  • this_task__*: Information about the specific task that triggered the webhook (e.g., this_task__id, this_task__title, this_task__status, this_task__completed_by__email, this_task__completed_at).
  • this_task__captures__*: Contains the values submitted to form fields within the completed task. The structure varies by field type (e.g., this_task__captures__field_alias__value).
  • next_task__*: Details about the task immediately following the completed task in the sequence (e.g., next_task__id, next_task__title, next_task__owners__users). This might be null if it was the last task.
  • process__*: Information about the overall process instance (e.g., process__id, process__name, process__status, process__created_at__date).
  • process__prerun__*: Contains values submitted in the kick-off form fields for the process.
  • process__process_forms__*: Contains values for all form fields across all tasks in the process up to that point.
  • template__*: Details about the template the process was launched from (e.g., template__id, template__title, template__version).

Refer to the sample JSON file linked above for the complete structure and specific field names.

Date Formats

Tallyfy lets you choose between two standard date formats for the dates included in webhook data. You select this when setting up the webhook.

Date Format Option 1Date Format Option 2

Security Note

Tallyfy webhooks include a special header called X-Tallyfy-OrgID which contains your unique organization ID. The system receiving the webhook can check this header for an extra layer of validation to ensure the message genuinely came from your Tallyfy account.

OrgID Header in Webhook

Webhooks > Details about webhooks

Tallyfy’s webhook system enables automated data transmission to external systems when specific events occur by sending JSON packets to predefined URLs at both template and step-specific levels.

Integrations > Webhooks

Webhooks enable real-time automated data transmission between Tallyfy and external systems by sending JSON notifications when specific events occur through middleware platforms or custom endpoints.

Webhooks > Send emails using webhooks

The system enables automatic custom email notifications through webhooks by connecting Tallyfy with middleware tools to trigger emails based on specific task completions or events within processes.

Launching > Triggers

Tallyfy offers multiple process launch methods including manual buttons API integration email triggers magic links schedules task completion triggers and kick-off forms with options to automatically populate data during launch.