Webhook Integration Overview

The Webhook Integration allows you to connect your Streamline workflows to external applications, APIs, CRM systems, or internal services. By authenticating a webhook connection, you can securely send data to outside systems and trigger downstream actions through the Outbound Webhook step.

Use this integration when you want your workflow to communicate with another system in real time, automate API-based processes, or send structured data externally.

Example Use Cases

You can use a Webhook Integration to:

• Send workflow data to external APIs or CRM systems and receive responses, such as generating an ID or retrieving calculated values.
• Query external systems during workflow execution to make real-time decisions, such as checking inventory or validating an address.
• Update records in external systems and confirm the result, such as creating a support ticket or updating a customer record.
• Connect to secure APIs that require OAuth scopes, such as systems that separate permissions for reading records, creating records, or updating records.

How to Add a Webhook Integration

Follow the steps below to create and authenticate a webhook connection.

1. Navigate to the Integrations Page

From the Streamline sidebar, open Integrations to view your existing connections and add new ones. Click New Connection in the top-right corner or middle.

2. Create a New Connection

After clicking New Connection, you will be prompted to:

• Search and select the Webhook integration option
• Provide a connection name that clearly identifies the system you're connecting to
  • Example: CRM API Webhook, HR System Webhook, Notifications Service Webhook

3. Select an Authentication Method

Choose one of four authentication methods based on the requirements of the external service:

• Basic Authentication - Authenticate using a username and password.
• Bearer Token - Authenticate using a Bearer token provided by the external system.
• OAuth 2.0 - Authenticate using client credentials and a token exchange. Required fields include:
  • Client ID
  • Client Secret
  • Token URL
  • Scopes, if required by the external system
• Custom - Create custom header authentication by adding header keys and values. Use this for systems that require specialized or non-standard authentication formats.

4. Complete Authentication

After entering your credentials, save the connection.

Once authenticated, your webhook integration will appear in your list of available connections.

You will also see the Webhook option when configuring an Outbound Webhook step in your workflow.

Using OAuth Scopes

Some external systems require OAuth scopes before they will allow an API request. A scope tells the external system what permissions Streamline is requesting when it gets an access token for an Outgoing Webhook.

If the API you are connecting to requires scopes, enter the required scope values when configuring the OAuth 2.0 Webhook Integration. If the external system does not require scopes, leave the field blank.

Using scopes helps connect Streamline to APIs that require more specific OAuth permissions. It also supports least-privilege access by letting the webhook request only the permissions needed for that integration.

Tip: Check the external system's API documentation for the exact scope values to enter. Scope names and formats are controlled by the system you are connecting to.

Using the Webhook Integration in Workflows

Once your webhook integration is created, it can be selected in an Outbound Webhook step for authenticated requests. For endpoints that do not require authentication, you can use the Outbound Webhook step without creating an integration.

To learn more about configuring the Outbound Webhook step, see:

Outbound Webhook Step - How It Works

Troubleshooting

OAuth 2.0 Connection Fails Because of Permissions

If an OAuth 2.0 Webhook Integration authenticates but the Outbound Webhook step cannot complete the API request:

• Confirm whether the external system requires scopes.
• Confirm the scopes entered in Streamline match the external system's API documentation.
• Confirm the connected OAuth application is allowed to request those scopes.
• If multiple scopes are required, confirm the external system's expected format, such as space-separated values.