Webhooks (Orchestrator)

Content is machine translated from English by Phrase Language AI.

Webhooks notify external services such as chat clients or other external APIs of events. A webhook can set a URL when a specific event takes place.

Phrase Orchestrator provides a service that monitors and processes notifications from third-party systems. This service enables users to connect their workflows with a wide variety of external systems that support HTTP requests.

Incoming Webhooks

Users can create a new trigger for incoming webhooks from external events with the system automatically generating a unique webhook URL with API key for the third-party webhook setup. The generated webhook URL is unique and directly associated with the user's account and workflow, meaning each webhook is only tied to one workflow.

Configure incoming webhook

To configure an incoming webhook, follow these steps:

Drag and drop a Webhook trigger into a workflow.

The trigger appears in the workflow.
Click on the trigger to open the Overview tab.
Select the Webhook tab.
1. Copy the Webhook URL.
  
  This URL should be considered a secret and not shared. If accidentally shared, click Regenerate to create a new one and invalidate the existing one.
2. To send a payload with data to use inside the workflows, provide the schema of that payload.
  1. To provide a schema, click Edit webhook.
  2. Select an Input Type:
    
    JSON Schemas are a standard for defining JSON payloads. If an existing service that uses them, or an external service to connect to Orchestrator provides one, copy it as-is.
    - JSON
      
      Provide a sample JSON payload for a simpler setup, allowing testing of the webhook without defining exact rules.
    - JSON Schema
      
      Precisely define the structure, data types and validation rules for the JSON data.
  3. Click Save payload schema.
    
    A preview of the expected data structure for the webhook trigger is displayed.
3. If required, open the Filters tab to add filters to the trigger.

To trigger a workflow once it has been published, send a POST request to the webhook URL. For workflows that do not have a configured schema, the body must be empty. If a configured schema is applied, the payload must match the schema.

Outgoing Webhooks

Users can set up workflows that not only receive data but also send updates to external systems automatically. The outgoing webhook action allows users to automatically trigger specific actions in external systems.

Webhooks in other services can be triggered through the Send HTTP Request action.

Configure an outgoing webhook

To configure an outgoing webhook, follow these steps:

Drag and drop a Send HTTP Request action to the workflow.
Click on the action to open the configuration.
Select the Parameters tab and provide the required settings.
Click Save parameters.