Signal Connector Integration with Webhooks Guide

Certain Signal Connector: Webhooks Integration Guide

This document is a guide to using Certain Signal Connector to integrate with other applications by using Webhooks. It does not cover the ‘Advanced Webhooks’ product, which includes everything described here plus the use of nested JSON — please see the separate guide to integrations using that product (Signal Connector also integrates with Marketo, Eloqua, and Salesforce — see separate guides.).

Certain Signal Connector for Webhooks is automatically included with Certain Platform for new customers. If you’re interested in adding this or any other Signal Connector integration to your instance of Certain, please email help@certain.com, including your account name and the Signal Connector integration(s) you’re interested in.

Contents

1. What is Signal Connector? How does it work? 2. Prerequisites • Data-Flow Considerations • Credentials in Target Application 3. Overview of Setup Steps 4. Setting up Tags • What Are Tags? • Setting Tags Up for an Account • Applying Tags in an Account • Applying Tags in an Event 5. Opening Certain Signal Connector 6. Setting up a Connection • What are Connections? • Adding a Connection 7. Setting Up Flows • What is a “Flow”? • The Flow List • Configuring a Flow 8. Flow Data Source • Available sources • Activate for 9. Flow Filters 10. Flow Destination • Setting up a Destination • Mappings 11. Metrics Dashboard • Account Insights 12. The Retry Queue 13. Replaying a Flow

What is Signal Connector? How does it work?

Certain Signal Connector processes data from your events in real-time, passing it from Certain Platform to your target third-party application, which could be any app with webhook integration, such as Slack or Google Forms.

This real-time integration empowers sales and marketing teams to take intelligent, prompt action on the right event data.

Almost everything is set up at the account level. Signal Connector processes information from the events in your account. For event-level information, this is based on the custom tags you attach to data such as Registration Statuses, as explained in this guide.

Important: Signal Connector processes outbound information, processing information from Certain and sending it to your target application.

Prerequisites

Data-Flow Considerations

Credentials in Target Application

For you to set up a Connection in Signal Connector, the administrator of your target third-party application will need to provide you with the information described under ‘ Adding a Connection ’.

For example, if your chosen Authentication Method there is OAuth2 then they’ll need to create an OAuth2 app in that system, and provide you with the following: Endpoint, Client Id, and Client Secret.

Overview of Setup Steps

StepPage
On Certain Platform 1. Add tags in the accountSetting Tags Up for an Account
2. Apply those tagsApplying Tags in an Account
On Certain Signal Connector 3. Add a ConnectionSetting up a Connection
4. Configure a FlowSetting Up Flows

Setting up Tags

What Are Tags?

Tags are a way of identifying event-level data using labels you set at the account level.

You can then apply those tags to generic items in events, especially custom registration statuses and custom registration properties for use in Certain Signal Connector. (Tags can be used for other purposes as well, but this guide doesn’t cover that.)

For example, your events may have several custom registration statuses in addition to the standard ones. You can apply the same Tags to more than one status, or you might choose to give each one its own Tag.

When you set up a Flow in Certain Signal Connector to send data to your target application when an attendee’s Registration Status changes, for example, you specify the tags applicable to those statuses, not the statuses themselves. That means the flow can apply to any event in your account.

Setting Tags Up for an Account

1. As an Administrator, go to Account Settings > Management >Tags. 2. Enter a Name and a Label for the tag. 3. Select the Object(s) to which the tag can apply; for example, ‘Registration Statuses” and/or “Custom Registration Properties’. 4. Click Add. 5. Repeat as required for as many tags as you need. 6. Important: Add enough tags to apply to all of the following that you will use in flows (see Setting up Tags ): a. Registration Statuses b. Custom Registration Properties 7. Also add enough tags to apply to all of the following that you will use in filters for flows (see Flow Filters ): a. Attendee Types b. Events

Applying Tags in an Account

In each event from which you want information to flow through Certain Signal Connector, apply tags to the relevant information: Registration Statuses and Registration Custom Properties.

(You can also tag Attendee Types and Events to filter registration records by attendee type or event: see Flow Filters.)

Default Registration Statuses

These apply to all events, so an Administrator applies the tags at the account level.

1. Go to Account Settings > Management > Registration Statuses. 2. Select one or more Tags for each status.

Important: Even if you don’t use any standard registration statuses, best practice is to set up tags for all of them, but it’s essential to tag at least the ‘ New ’ status (which Certain uses “behind the scenes” when first processing each registration).

If you do use standard reg statuses, it’s essential that you tag them all, so that you can use them in the Flows you configure in Signal Connector: see page 9.

Applying Tags in an Event

Custom Registration Statuses

1. If any of the Flows you configure in Signal Connector will watch or activate for changes of Registration Status (see Available sources ): In each event, go to Plan > Event Setup > Custom Statuses 2. Select at least one tag for each status.

Custom Registration Properties

If any of the Flows you configure in Signal Connector will watch or activate for Custom Reg Properties (see Flow Data Source ):

1. In each event, go to Plan > Configure. 2. Under Custom Registration Properties, select at least one tag for each custom reg property in the event.

Standard Registration Properties (Automatic)

These tags are set up for you automatically, with names identical to the properties themselves: Complete, Badge Printed, On To Do List, Invoice Generated, and Test.

You only see them in Signal Connector, where, just like Custom Reg Properties, you can activate Flows for them (see Activate for … ). There’s nothing to edit on Certain Platform.

Attendee Types

(Optional– for use with filters – see Flow Filters )

1. In each event, go to Plan > Event Setup > Attendee Types. 2. Select one or more Tags for each attendee type on which you may wish to filter registrations. (See Filters on see Flow Filters.)

Events

(Optional– for use with filters – see Flow Filters.)

1. In each event that you may wish to include in a filter (for example, to ensure that only registrations for that event are passed to your target application): 2. Go to Plan > Event Setup > Details. 3. Select one or more Tags for the event.

Registration Questions

(Optional– for use with mapping Certain fields to fields your target application – see Mappings.)

1. In each event in which you use registration questions to capture data from attendees and wish to pass those answers and/or questions to your target application: 2. Go to Plan > Event Setup > Questions. 3. Select just one Tag for each question. (Selecting more could result in duplicate data in your target application.)

Opening Certain Signal Connector

When Signal Connector is activated for your account, the Account Settings > Implementation menu—available to Administrators—includes an extra option:

Click that link to open Certain Signal Connector in a separate window; it runs separately from Certain Platform.

Note: To return from Signal Connector to Certain Platform at any time, click

Setting up a Connection

What are Connections?

A Connection in Certain Signal Connector specifies how to connect to your target application.

You can actually have multiple connections, including to other third-party applications. (Marketo, Eloqua and Salesforce are covered in separate guides.)

Each Flow (see Setting Up Flows ) requires a Connection. Multiple flows may use the same Connection.

You can set up a Connection before configuring your first Flow, but you also have the option to do so while configuring a Flow. This guide assumes you’re setting up the Connection first.

Adding a Connection

As an Administrator, you may set up one or more Connections for your account. You need only do so once – you can then use them in the Flows you set up (see Adding a Connection, below).

1. Go to Account Settings > Implementation > Signal Connector Real-Time Data Integration.

2. As noted above, Certain Signal Connector opens in a separate window.

3. Click Connections in the left navigation panel.

4. Click Add A Connection in the Connection List page that opens.

5. Enter the details in the Connection Setup screen that opens.

Basic Authentication

Open / No Auth

The lowest level of security

API Key / Token

OAuth2

All these values must be provided by the administrator of your target application.

6. Click Save & Test. 7. If the test is successful, click Close. If it’s not, check that the values in step 5 are all correct.

Setting Up Flows

What is a “Flow”?

A flow is a configuration to manage the flow of data from Certain to your target application. You create Flows from the landing page in Signal Connector: see Configuring a Flow, below. You may configure several flows for an account, which might all use the same Connection (explained above).

You only need to configure a flow once at the account level. When a flow is complete, it will start picking up data for each event in that account within about a minute.

The minute’s delay is because Signal Connector runs independently from Certain Platform. So if you edit a flow then the same slight delay occurs before that change takes effect in the processing of the registrations.

The Flow List

As an Administrator in Certain Platform. go to Account Settings > Implementation > Signal Connector Real-Time Data Integration.

As noted above, Certain Signal Connector opens in a separate browser window.

The main screen in Signal Connector is the Flow List, which lists all flows.

The Status column shows whether a flow is completely set up.

The Active column shows whether the flow is running. Click the toggle button to change a flow from Active to Inactive, or vice versa.

Configuring a Flow

Click ADD A FLOW to start setting up a new flow – see screenshot overleaf.

The configuration consists of:

‘Live’ or ‘Test’

The Live toggle switch determines whether your Flow is Live or Test:

Best Practice: Set a new flow up as Test—and test it—before setting it to Live.

Flow Data Source

Next, specify the Source of data for the flow (optionally applying Flow Filters ).

The Source of a Flow is what the Flow will watch for in your data in Certain and when it will activate based on that data.

For example, it might watch for any change to a Registration Status and activate if an attendee’s status has changed to a status tagged as ‘Registered’.

Available sources

You set a flow to watch for any one of the following:

Note: You can always save an incomplete Flow and complete it at a later date. As soon as a Flow is complete, it will start picking up data after the usual minute’s delay.

Activate for …

Choose what the flow should activate for by selecting one or more tags in each appropriate object’s dropdown list

As shown in the screenshot above, you can activate for tags applied to Registration Statuses and/or Registration Properties. Other options may be added depending on what the Flow is watching for:

The tags available for selection are those set up for that object; see Setting up Tags.

For example, the tags for Registration Statuses include Registration Status tags, which you can apply to:

Flow Filters

You can filter the data going into a flow by selecting fields in any of these three filter types:

The flow will only include a registration if it meets the rule(s) specified in the filter.

Note: For custom fields you can only select “enumerated” questions – those that have pre-configured answers; that is, questions that are of types Select, Multi-select, Checkbox, or Radio.

Flow Destination

Select Webhooks from the integrations set up by Certain for your account. (You may have this and others to choose from.)

Setting up a Destination

1. Give the Destination a Name of your choice, 2. Select the Connection to use.

Note: You can instead click New Connection to add a connection; the process to set one up is the same as described on Setting up a Connection.

3. Select Webhook as the Action for this connection.

4. Select or add the mappings to use, as described next,

Mappings

Select or set up a set of mappings. You can have two: one for the Payload and (if required) one for the Http Header.

The setup process is the same for each:

A mapping specifies how each target field in your third-party application matches a source field in Certain.

Select a mapping from the drop-down list.

If nobody has set any mappings up yet, or you need something other than one of the existing mappings, click New Mapping to add one:

1. Give the mapping a name of your choice. Best Practice: For multiple mappings used for different flows, make the names self-explanatory. For example, ‘Lead Mapping’ and ‘Contact Mapping’

2. Obtain a sample JSON from the source.

3. For each of the target fields you identify in that JSON, such as FirstName in the example above:

a. Enter the name of that target field and Click Add

b. Click to select the “source” field in Certain that matches that target field. In this example, the target field in your target application is ‘First Name”, so you select the source field “FirstName” in Certain; the value of that Certain field will populate the “First Name” field in your target application.

The result:

The Certain fields you can choose from as the source of the data going into each target field in your target application will include some of the following, depending on what your flow will activate for. (If, for example, it will activate for Event Statuses, then you can only map event fields.)

Note: You can concatenate multiple source fields for the same target field, and even type fixed text.

For example, for target field ‘Title’ you could choose source fields ‘Position’ and ‘Organization’, separated by two spaces and “@”

c. To make a target field a required field, select the checkbox next to it.

d. To delete a source field, click the x after its label.

4. In the second column you can select a transformation option for each field. The default of no selection means the data will be sent to your target application unchanged. The options are:

Note: You can select more than one transformation for a field. For example, you could change it to Proper Case and trim it.

5. Continue adding more target/source field pairs as necessary.

If you’ve selected a mapping then two other buttons are enabled, with self-explanatory labels:

6. Save the mapping,

Metrics Dashboard

To see the statistics available in Signal Connector, click Metrics in the left navigation panel when looking at flows.

The choices in the new navigation panel you then see for Metrics depend on the flows and their targets.

The first one will be Insights, as illustrated and described below.

Other links will be, for example, Webhook Posts; all work in the same way as Account Insights.

Account Insights

Select whether you want to see Live Flows or Test Flows.

Select the period for which you want to see the data; for example, for the last 15 minutes, 1 hour or 4 hours, or a number of days.

There are three tabs: Summary, Troubleshooting, and Activity Feed.

Drilling down into the failures provides a high-level view for troubleshooting. For example, you can see why an action has failed. If that’s something you can address, then once you’ve done so you can expedite the fix in Signal Connector by going back to Flows and clicking Retry in the left navigation panel — see Retry Queue.

The Retry Queue

When an action fails it usually joins the “ Retry Queue ”, where it takes its turn to run again. (Failures that can’t be resolved, such as missing mandatory fields, are exceptions: they don’t join the queue.) An action can be retried up to three times, after which it does not rejoin the queue.

To see the Retry Queue, click Retry in the left navigation panel on the Flows page:

Causes of failure include ones under your control as a planner, such as a registration with a status that hasn’t been tagged, and technical ones such as a connection being down.

Where you can resolve the cause of a failure, such as tagging a registration or setting a flow back to being active, that’s all you need do. The action should succeed when retried.

For other failures that don’t resolve themselves, you probably need to contact your administrator or ask Certain for help.

The interval between retries depends on the severity of the reason: the more serious the reason the sooner the retry.

Filtering the Queue

You can filter the records shown in the Retry Queue using these three filters:

Submitting to the Queue

When you click an item in the Retry Queue, you see its full details.

If that knowledge is enough for you to solve the problem, then once you have done so you can click Submit to Retry Queue, which adds the item straight to the front of the queue.

Replaying a Flow

If you change an aspect of a flow while it has been running for some time, such as changing its filters, you may want to replay that flow for the same registrations as before, as if the changes had been made earlier.

This is not something that you can do directly, but you can ask Certain to arrange it for you. You may be able to specify a date range, or even an event.

Source: https://platform-support.certain.com/hc/en-us/articles/10901681579031-Signal-Connector-Integration-with-Webhooks-Guide

Published:

Keywords: Signal Connector, Webhooks, Certain Platform, Flow, Retry Queue