Skip to main content

Workflow Action: Webhook

The Webhook workflow action sends data from Kyrios to an external system in real time using a GET or POST request.

Updated over 2 months ago

Who This Is For / When to Use

Use the Webhook workflow action if you need to send Kyrios data to an external platform such as Zapier, a custom API, or another system that accepts webhooks.

This is commonly used when:

  • A required integration is not natively available.

  • You need advanced or custom data exchange.

  • You want real-time sync triggered by workflow events.

What the Webhook Action Does

The Webhook action sends structured data from Kyrios to an external URL when a workflow reaches that step.

Key characteristics:

  • Supports POST and GET methods.

  • Sends standard data automatically (based on the trigger).

  • Allows up to five custom key-value pairs.

  • Supports custom headers (for API keys, authorization, or content type).

Supported Request Methods

Webhooks can be sent using either method:

  • POST
    Sends data to an external system (most common use case).

  • GET
    Requests or retrieves data from an external system.

Use the method required by the receiving platform’s API.

How to Add a Webhook Action in a Workflow

Step 1: Add the Webhook Action

  1. Open your workflow.

  2. Click + Add Action.

  3. Select Webhook.

Step 2: Configure Method and URL

  1. Enter an Action Name (internal reference only).

  2. Choose the Method (POST or GET).

  3. Paste the Webhook URL provided by Zapier or your external system.

Step 3: (Optional) Add Custom Data

Custom data lets you send specific values in addition to standard workflow data.

Rules:

  • Maximum of 5 custom fields.

  • Each field requires a Key and a Value.

  • Values can be selected using the Kyrios value picker.

Example:

  • Key: address

  • Value: Contact → Address

Step 4: (Optional) Add Headers

Headers are required when the receiving system needs authentication or specific formatting.

Step 5: Save and Publish

  1. Save the Webhook action.

  2. Publish the workflow to activate it.

Example JSON Payload (POST)

This is a common example of sending contact data using a POST request:

The exact fields available depend on the workflow trigger.

Example Headers Configuration

Example of headers required by many APIs:

Common Use Case Example

Scenario: Sync New Contacts to an External CRM

  1. Trigger: Contact Created.

  2. Action: Webhook.

  3. URL: External CRM API endpoint.

  4. Method: POST.

  5. Payload: Contact name, email, phone.

  6. Headers: Authorization token.

Result:
Each time a new contact is created, Kyrios sends the contact data to the external CRM automatically.

Testing Your Webhook

Before relying on a webhook in production:

  • Use tools like Webhook.site or Postman to confirm data delivery.

  • Verify headers, payload format, and response codes.

  • Ensure the receiving system is reachable.

Data Sent by Webhooks

The data included depends on the workflow trigger:

  • Forms: Form fields and contact data.

  • Appointments: Appointment details and contact data.

  • Contact triggers: Contact fields and tags.

  • Raw webhooks: Raw payload defined in the action.

Common Issues and Fixes

Webhook Does Not Fire

  • Confirm the workflow is published.

  • Verify the trigger conditions are met.

Authentication Errors

  • Check headers for missing or invalid API keys.

  • Confirm the authorization format required by the external system.

Data Missing or Incorrect

  • Verify value picker fields are mapped correctly.

  • Confirm the external system expects JSON format.

FAQ

Can I customize the data sent through a webhook?

Yes. You can add up to five custom key-value pairs and define a custom JSON payload.

Do webhooks send data in real time?

Yes. Data is sent immediately when the workflow action is reached.

Can I use webhooks without Zapier?

Yes. Any system that accepts webhooks or API requests can be used.

What is the difference between POST and GET in the Webhook action?

POST sends data to another system. GET retrieves data from another system.

What happens if the webhook URL is invalid?

The request fails and the external system will not receive data. Always test before publishing.

Did this answer your question?