Getting Started

To set up your Custom HTTP:

Step 1. Create the Custom Event
Step 2. Customize your HTTP payload
Step 3. Add the event trigger

📘

If this is your first time configuring events, please read About Events.

Step 1. Create the Custom Event

You can create as many custom events as you want. Remember that they have to be of event type: Item Snapshot. If the event has already been created, skip to Step 2.

  1. Log in to your enterprise web portal (e.g., example.zyllem.com)
  2. Go to Settings > Events
  3. Click Custom Events tab and then + Add custom event
2339
  1. Fill in the form (*required)
4400
FieldDescription
NameName of your event
DescriptionOptional description of your event
Event TypeSelect Item Snapshot Event. Note that other events are not supported
  1. Click Save. You should see your newly created event on under Custom Events tab.
417

Step 2. Customize your HTTP payload

  1. Click on the custom event you have created in Step 1.
  2. Click + Add and then HTTP
3246
  1. Fill in the form (*required)
1581
FieldDescription
Name of Notification*The name of webhook activity
Notification DescriptionOptional description of notification
HTTP URLYour client endpoint. Tip: You can insert a variable here, except for variables that consist of URLs such as the Tracking URL
HeadersIf your endpoint requires authentication (e.g., username, password), click Add row to add the key and value.
URL ParametersIf your endpoint requires other parameters, click Add row to add the key and value.
Plain Text EditorThis is where you customize your payload. See below for tips

📘

Inserting variables in your payload

You can insert a range of data variables associated to the item such as custom properties, contacts, users and addresses and so on. See full list of variables and their description.

To insert a variable, under COMMON VARIABLES, double click on the variable name while on edit mode. This will automatically copy-paste it into the editor. Below is an example of a payload:

2857
  1. Click Save, then Test to test your HTTP call (recommended).
3026
  1. When you're all set, click Save. You should see your newly created HTTP event in the list.
1008

Step 3. Add the event trigger

  1. Open your Bridge. Or see the step-by-step guide for adding Triggers.
  2. Go to the point in the Bridge where you wish to add the trigger and click + Add Trigger.
4162
  1. Trigger Type, select Fire Event and click Next.
  2. Fill in the form (*required)
1168
NameDescription
Name*Name of the trigger
DescriptionOptional description for the trigger
Execution conditionSee table below
EventSelect the event you have created in Step 1.

For the Event condition field, refer to the table below:

1001
  1. Click Save.
  2. Publish your Bridge by clicking on Meta Data tab and then Publish.