Webhooks

Create endpoints to receive incoming data and trigger flows.

When to Use

  • Trigger flows from external systems
  • Implement callback endpoints
  • Receive real-time notifications
  • Build integration APIs for outside use

Settings

Basic

  • Description: Name this webhook
  • Endpoint Path: URL path (e.g., /orders/new)
  • Method: Accept GET, POST, etc.
  • Authentication:
    • None (open)
    • API Key
    • Basic Auth
    • OAuth2

Request Handling

  • Content Type: Expected request content
  • Validation: Rules for incoming data
  • Schema Validation: (optional) JSON schema

Response Config

  • Status Code: HTTP code to return
  • Response Body: Template for response
  • Headers: Custom response headers

Access Webhook Data

  • Body: $.webhook.body
  • Query: $.webhook.query
  • Headers: $.webhook.headers

Tips

  • Secure sensitive endpoints
  • Use descriptive, not guessable, URLs
  • Validate requests properly
  • Rate-limit public webhooks
  • Test with Postman or curl
  • Use webhook URL in external system configs