Skip to content
/
Webhook Output Streaming...
Last updated

Webhook Output Streaming Integration

This Webhook integration allows you to specify a streaming output connection from Treasure Data to your third-party service or platform of choice.

When creating the authentication for this integration, you specify the following:

  • URL—the API endpoint of the service or platform you want to stream to
  • API Key—a key that will authenticate the API calls made by the Webhook integration

Later when using the TD Console to create a triggered activation, you can specify this webhook authentication and then specify the following:

  • The endpoint URL
  • Custom headers for the API request
  • Output payload

Prerequisites

  • Basic Knowledge of Treasure Data
  • Basic knowledge of the APIs supported by your third-party service or platform

Use Cases

The primary use case for this streaming integration is to incorporate it into a real-time activation workflow. Here is an overview of how to configure that workflow:

  1. In the Integration Hub, create an authentication for this integration to communicate with the platform you want to use.
  2. In a Real-time Journey, specify this authentication in your real-time triggered activation.

Limitations

  • Oauth 2.0 is not supported.
  • Currently the integration does not check for duplication in request headers. You will need to ensure that you do not specify any duplicate headers.
  • Request payloads cannot exceed 250KB.
  • Limit of 32 custom request headers supported.
  • RT 2.0 Triggered Activation does not support PII-hiding.

Obtaining the Webhook API Key

You will need to have an API key to authenticate the API calls the integration will make to your third-party service or platform. Refer to the third-party documentation on how to obtain a key with sufficient privileges to support streaming output from the Webhook integration.

Use the TD Console to Create Your Connection

You must create and configure the data connection in Treasure Data. As part of the data connection, you provide authentication credentials to access the integration.

  1. Open the TD Console.

  2. Navigate to Integrations Hub > Catalog.

  3. Select the search icon on the far right of the Catalog screen, and type Webhook.

  4. Hover over the Realtime Webhook Activation connector and select Create Authentication.

  5. For URL Prefix, enter the baseURL of the API endpoint. All Webhook triggered activations using this Authentication must use a matching baseURL in their URL endpoint.

  6. For API Key, enter the authentication secret of the webhook. When configuring the real-time triggered activation in Audience Studio, you can specify this secret using the variable {{auth.api_key}} in custom headers, in the API endpoint itself, or in the request body.

  7. Select Continue.

  8. Enter a name for your authentication.

  9. Select Done.

The Webhook Output Streaming integration is now available to be incorporated into real-time customer journey activations. See Creating a Real-time Triggered Activation for additional information.

Previous page
Next page