Converge Webhook

Installation Instructions

Create a new Webhook Source in Converge

In Converge, click on Create a new source
Pick Server-side from the modal
Name your server-side source: e.g. {Storename} Store Backend
Click on Create Source.

Send a dummy event

Click on your newly created Source. You will see a Webhook Endpoint URL and Webhook Token under the source configuration tab.

The Webhook Token has been added recently to improve error messaging for easier issue diagnosis. Existing integrations that do not use a Webhook Token remain unaffected.

The Webhook Endpoint is the URL where you’ll send the events to.
Ensure the Webhook Token is included as a header using the header key X-Webhook-Token.
Verify that your Webhook Source is working by sending a dummy Placed Order event request. Ensure the request meets the following parameters outlined in Manually instrumenting events

Code example

You should include the webhook token from the Converge UI in the code example below

curl -X POST \
"https://app.runconverge.com/api/webhooks" \
-H "Content-Type: application/json" \
-H "X-Webhook-Token: {YOUR_WEBHOOK_TOKEN}" \
-d '{
 "event_name": "Placed Order",
 "event_id": "order-1",
 "properties": {
     "id" : "order-1",
     "total_price": 42,
     "total_tax": 3.5,
     "total_shipping": 2.4,
     "currency": "USD",
     "items": [
         {
             "product_id": "123456",
             "variant_id": "654321",
             "sku": "MY_SKU",
             "name": "My Product",
             "price": 42,
             "currency": "USD",
             "quantity": 1,
             "vendor": "My Store"
         }
     ],
     "$is_new_customer": false,
     "$sales_channel_type": "web"  # important, see supported sales channels
 },
 "profile_properties": {
     "$first_name": "John",
     "$last_name": "Smith",
     "$email": "john.smith@apple.com",
     "$phone_number": "+199999999",
     "$city": "San Francisco",
     "$country_code": "US",
     "$state": "California",
     "$zip_code": "94103"
 },
 "aliases": ["urn:email:john.smith@apple.com"]
}'

Verify that your event arrived in Converge

Click on your newly created Source and choose the Logs subtab. You should see the event you just sent in there.

Manually instrumenting events

If the pre-built server integrations do not cover the applicable conversions from the Converge Event Spec; or if you want to add custom events from your website then you will need to manually instrument these using the Converge Pixel. You can use the Webhook source to manually instrument these events.

As a general rule, you should always aim to pass as many properties, profile_properties, and aliases as possible

The webhook body has the following parameters:

Parameter	Type		Description
`event_name`	`string`	Required	The name of the event
`event_id`	`string`	Required	The ID of the event, used for deduplication
`properties`	`object`	Required	The event properties you want to pass, covering the Converge Spec and possibly your own custom properties.
`profile_properties`	`object`	Required	The profile properties
`aliases`	`array[string]`	Required	Any aliases. Must contain at least one alias, with a maximum of 10 aliases allowed.
`timestamp`	`datetime`	Optional	The date and time when the event occurred. If not provided, the current time will be used. The timestamp can be expressed as a string in ISO 8601 format (e.g. `"2024-09-02T12:34:56+00:00"`) or a UTC timestamp (e.g. `1725312229`). The string representation must specify a timezone.

Event Spec

This integration does not auto-track any events by default. All events should be instrumented manually according to the Converge Event Spec.

You should typically implement Placed Order and Started Subscription events server-side. You can find a full list in the Converge Spec here

Sales Channels

Due to the events being instrumented manually, particular importance is placed on sales channels because of concepts like deduplication and session stitching. When choosing a sales channel type for an event, if you expect a conversion (e.g. Placed Order) to have a corresponding web journey, then you’ll want to typically categorize them as “web”. If the event is automated, say, a recurring subscription order, then you’ll want to use “subscription_contract”. If you’re selling your products on a marketplace like Amazon for example, and you intend to forward these Placed Order events to Converge via the webhook, you’ll want to categorize them as “marketplace”. More on sales channels can be found here.

If no sales channel type is provided, Converge falls back to “web”.

The following supported sales channel types are:

Name	Property Value	Description
Web	web	Events occurring via browser-based interactions and actions
Subscriptions	subscription_contract	Automated events related to subscription renewals or contracts.
SMS	sms	Events or interactions triggered via SMS/Text communication.
Mobile App	mobile_app	User interactions occurring within mobile applications.
POS	pos	Point of Sale transactions taking place in physical stores.
Marketplace	marketplace	Sales and interactions through third-party marketplaces like Amazon.
Offline	offline	Offline events such as amended orders, manual orders, or calls.
Facebook Shop	facebook_shop	Purchases and interactions through the Facebook Shop channel.
Pinterest Shop	pinterest_shop	Sales and activity through the Pinterest Shop channel.
TikTok Shop	tiktok_shop	Orders and interactions made via the TikTok Shop channel.

Getting started

Implementation

Sources

Destinations

Data Warehouse

Attribution

Insights & Dashboards

Marketing Sources

Data Management

Settings

Installation Instructions

Manually instrumenting events

Event Spec

Sales Channels

Getting started

Implementation

Sources

Destinations

Data Warehouse

Attribution

Insights & Dashboards

Marketing Sources

Data Management

Settings

​Installation Instructions

​Manually instrumenting events

​Event Spec

​Sales Channels

Installation Instructions

Manually instrumenting events

Event Spec

Sales Channels