Webhooks

Overview

Webhooks in Iconnek allow external systems to trigger scenarios by sending data to a dedicated endpoint. They provide a mechanism for real-time integration between systems, enabling automated workflows based on external events.

Creating and using webhooks

Step 1: Create a webhook

• Navigate to Data Triggers > Webhooks in the main menu

• Click the + New webhook button

• Enter a descriptive name for the webhook

• Click Save

Step 2: Link webhook to scenario

Before using a webhook, you must first create a scenario that will process the incoming webhook data.

• Link the webhook to your scenario as a trigger

• Once linked, you'll see the webhook icon appear in your scenario

Technical Specifications

Webhooks are designed to support only POST requests, meaning they exclusively accept incoming data via the HTTP POST method. This method allows webhooks to send information from one system to another, typically used to deliver real-time updates or trigger specific actions when an event occurs. Other HTTP methods, such as GET or PUT, are not supported.

Payload Format

Webhooks in Iconnek accept JSON data as the payload format in the request body. When a webhook is triggered, this incoming data is automatically made available to your scenario for processing. Throughout the execution of your workflow, you can access and manipulate the webhook payload data in any subsequent steps of your scenario, allowing for dynamic processing based on the received information.

Best Practices

• Webhook Naming:

  • Use descriptive names for webhooks to easily identify their purpose

  • Consider including the target system or event type in the name

• Error Handling:

  • Implement error handling in your scenarios to manage failed webhook processing

  • Set up notifications for webhook failures

• Security:

  • Keep webhook URLs confidential

Example Use Cases

• Real-time inventory updates

• Order status notifications

• User registration events

• Payment processing notifications

• CRM event triggers