The great thing about our Campaign Designer is that it contains a lot of objects to give you numerous possibilities, but we understand that it might get confusing at times. Our best tip is to just give it a try! Create a new campaign and experiment with the objects. Use a test group with your own record to select possible customers and you can’t really go wrong.

To help you, we have provided a description of the various objects and included them in the manual under the categories as you would find them in the objects library in Deployteq.



Start Objects

In Deployteq, Start Objects are used to start a Campaign flow. This start can happen automatically, at a set time or following an incoming 'event' (such as a customer clicking or registering on the website). The various objects are detailed below.

Note

Each separate active flow within the same Campaign must have a Start object as its starting point. This ensures that Deployteq always works with the correct customer selection within the flow.

IconFunctionSettings


Use the ‘Start on Time’ object to activate a path in the campaign at a predetermined time.

Give the object a name. You can then choose between two types of start times: Campaign Start or Static.

If you choose ‘Campaign Start’, the path will be activated as soon as you turn on the campaign. If the start date is changed in the campaign settings, the start date for the path will also change.

For ‘Static’, you must enter a set date and time. This can also be at a time after the campaign has already started.

Comment

A campaign can contain multiple paths and therefore also have multiple start times.

The ‘Start on Event’ object specifies the starting point of a campaign path. Unlike the ‘Start on Time’ object, the starting point is not determined by a predefined time, but by when an event occurs. This could be a ‘Bounce’ from a QuickMail or an ‘Unsubscribe’ process started when a contact clicks on ‘Unsubscribe’.

The ‘Start on Event’ object can also be used to activate a campaign path on the basis of a form not defined in Deployteq, but defined on the contact’s website. The object can read the values from the form and make them available within the campaign, so that they can be processed in Deployteq.

The ‘Start on Event’ object will become the default starting point of a campaign when a ‘Bounce’ or ‘Unsubscribe’ process is created using the Campaign Designer.

The ‘Start on Event’ object has a URL. When you place a form with an iframe on your website, it is best to use the URL of this start object. This is because it does not change, even though you may use a different page or want to perform an extra action before the customer arrives at the landing page.

In addition, you can set variables that can be saved as part of environment variables. These can be enclosed with the URL.

A path in the campaign can be activated at a predetermined date and time, and this can be repeated at set intervals.

Give the object a name and configure the start time. If you choose ‘Campaign Start’, the path will be activated as soon as the campaign goes live.

If the start date is changed in the campaign settings, the start date for the path will also change. For ‘Static’, you must enter a set date and time.

This can also be at a time after the campaign has already started.

You then configure the repeat interval and, if desired, specify an end date for the interval.

Use the ‘Start on SMS’ object to start a campaign via an inbound SMS.

You must specify in this object which keyword will trigger the start of the campaign. A ‘Start on SMS’ object can respond to more than one keyword.

Comment

This object is only available if you have activated the Deployteq SMS extension. Click here for more information about this extension.

The stop object makes it possible to halt a campaign. This can be set to happen if a contact follows a certain path through the campaign, or it can be set to take place at a certain time with the use of a timer. Users who enter the campaign once it has been stopped will be redirected to the ‘End URL’ for the campaign.

No configuration is necessary for this object.

User-defined campaign objects

Use this object to start the path in your own campaign object.No configuration is necessary for this object.

The ‘End Object’ makes it possible to stop a specific flow in a campaign for a specific customer or to direct them to another campaign. For more information, please read the explanation in the manual about 'user-defined objects'.Give the end object a name so that you can use it as an exit for your user-defined object in another campaign. The name you give this object will be used as a user-defined exit in the campaign object.


Channel Objects


IconFunctionSettingsExit

This object makes it possible to link the flow to the ‘Callcenter’ campaign within a campaign.

This object is a user-defined campaign object that you can configure as you wish. Customers pass through this object and are exported to your customer service department at a specified time. In this campaign object, you can configure which fields you want to have exported and at what interval.

  • Continue
  • End object

This object makes it possible to link the flow to the ‘Printer’ campaign within a campaign.


This object is a user-defined campaign object that you can configure as you wish. Customers pass through this object and are exported to your print queue at a specified time. In this campaign object, you can configure which fields you want to have exported and at what interval.
  • Continue
  • End object


Content Objects


IconFunctionSettingsExit

The Page object makes it possible to display a webpage from Deployteq.


Give the object a name and select a Page. The manual explains how to create pages in the topic Webpages (Pages).

Do you use manual fields on your pages? When selecting a page in the 'Show Page' campaign object, the default value of the manual field is displayed as a placeholder value (gray letters). The 'Show Page' object offers you the ability to:

  • Leave it blank (no placeholder, no default value used), or
  • Let Smarty decide in the page (shown by the placeholder), or
  • Set a fixed default value for that specific object.

  • On submit (if page has been sent)

The Form object makes it possible to display a form from Deployteq.

Depending on the configured form, this object functions as a subscribe, edit, or Forward-to-a-friend page.


Give the object a name and select a formAll fields in the form are displayed. These fields can be used later to create links between the various objects.

The ‘Existing customer’ and ‘New customer’ exits can be used with a subscribe form. These exits make it possible for existing contacts and new contacts to follow different flows.

If a Forward-to-a-friend form has been configured, you can choose in the object’s settings whether the contact is allowed to send an e-mail to a friend multiple times.

  • On view (if form has been viewed)
  • On submit (if form has been sent)
  • Existing customer
  • New customer

Use the ‘Send e-mail’ object to send an e-mail to one or more contacts.

Enter a name and select the e-mail you want to send. Choose from all the e-mails that have been created in the 'E-mail component' in Deployteq.

If your e-mail contains a variable field (link to Variables), you could enter the value of this field here for this mailing. Use ‘Throttle speed’ to specify the maximum number of e-mails you want to send per hour.

By ticking the ‘Send to a different e-mail address’ checkbox, you can send the e-mail to a different address. In this way, you can use this object to synchronize data.

Tip

With the ‘Throttle speed’ option, you can prevent your website from crashing as a result of your mailing generating too many simultaneous visitors, which your web server may not be able to handle.


Comment Start objects

The Send E-mail object can never be directly linked to a start object, except for the start on webhook object.

For the other start objects, no contacts are selected yet to to whom the email can be sent.

OnBounce Exit

In case of a bounce on the send email, the OnBounce exit is executed. This will set additional data in the campaign environment to determine the next best action based on the bounce. 

The following campaign environments are available when the "onBounce" exit is used:

bounce_code
When a bounce occurs a specific code is displayed. Each code has its own meaning. More information about the reason for the bounce can be obtained through the "bounce_reason" environment.

bounce_reason
Provides information about the cause of the bounce. For example if the "bounce_code" 422 is given the corresponding information is provided here. In this case the bounce code 422 means that the user's mailbox is full (the recipient’s mailbox has exceeded its storage limit).

bounce_type
Bounce type (hard/soft). Soft bounces are emails that cannot be delivered for a temporary reason. For example the recipient's mailbox may be full or there may be an issue with their mail servers. Hard bounces are emails that cannot be delivered for a permanent reason. For example the recipient's mailbox no longer exists. Codes in the 400-series are generally soft bounces and codes in the 500-series are generally hard bounces.

  • Continue
  • On bounce (if e-mail bounces)
  • On click (if click takes place in the e-mail)
  • On open (if e-mail is opened)
  • On complaint (if complaint is submitted)

The ‘Send SMS’ object can be used to send an SMS.

In this object, you specify what SMS content should be sent. You can specify whether the SMS should be sent to a different number. This is useful for test purposes or notification messages (e.g. when a new contact has subscribed).

If ‘Premium SMS’ has been activated for the brand, ‘reverse billing’ can be configured. This can be used to charge a contact a certain rate for an SMS sent to the contact.

Comment

You can find more information about the Deployteq SMS Extension and about activating this extension here.



  • Continue
  • On bounce (if SMS has been bounced)


Data model Objects


IconFunctionSettingsExit

With the ‘Data Model Import’ object, you can first start an import and then follow the campaign flow. This ensures that you always have the correct data before you follow the campaign and can avoid empty e-mails.JWhen you use this object, you will go through the import wizard as you are used to doing. If an error occurs, you could, for instance, send an e-mail to yourself. When the ‘On success’ exit is chosen, the flow will continue with the records that have successfully been imported.
  • Continue
  • On fail
  • On success

The ‘Get Data Model Record’ object selects a row from the data model.

Only the contact selected from the flow is used as a source. This object examines all the contact’s data model rows and ignores rows that may previously have been selected from the flow.

In ‘Table’, you can specify which table to retrieve a row from.

The columns in the table are made available as environment variables within the flow.

The names of the variables are displayed in the overview.

  • Continue
  • On record found
  • On record not found

This object can be used to iteratively start a separate flow for every record found. In other words, a flow is started for every row that is found. This allows you, for instance, to send an e-mail for every booking instead of sending an e-mail with several bookings to one person.

Specify the source: all contact data or only data from the current selection.

In ‘Table’, you can specify the table for which a flow should be started for each record.

  • Continue
  • For each

This object can be used to insert rows into the data model.

The contacts from the flow are used as a source. This object examines all the contact’s data model rows and ignores rows that may previously have been selected from the flow.

In ‘Table’, you can specify the table in which to modify the rows. Once a table has been chosen, a value can be specified for each column.

If you choose a table that hangs ‘underneath’ another table, you will first need to specify which row in that table should be chosen to add the underlying row to.

  • Continue

This object is used to retrieve a contact based on the data model.

The contacts from the flow are used as a source.

This object examines all the contact’s data model rows and ignores rows that may previously have been selected from the flow.

In ‘Table’, you can specify the table from which a row should be sought.

The columns in the table are made available as environment variables within the flow. The names of the variables are displayed in the overview.

  • Continue
  • On customer found
  • On customer not found

This object can be used to modify rows in the data model.

The contacts from the flow are used as a source. This object examines all the contact’s data model rows and ignores rows that may previously have been selected from the flow.

In ‘Table’, you can specify the table in which to modify the rows. Select the column to be modified and the corresponding value, and then underneath the condition for selecting the row.

  • Continue

This object can be used to delete rows from the data model.

The contacts from the flow are used as a source. This object examines all the contact’s data model rows and ignores rows that may previously have been selected from the flow.

In ‘Table’, you can specify the table from which to delete the rows. Filters can be used to select specific rows from that table.

  • Continue




Flow Objects


IconFunctionSettingsExit

The possibility to determine the next step in a flow based on whether or not a link has been clicked on.

When determining the next step to this object, you can exclude certain links in the e-mail (e.g. Continue on click, but not when the unsubscribe link has been clicked). Always set a timer because no one will have clicked immediately after the e-mail has been sent.

It is also possible to determine the next step when a specific link has been clicked on. This is done by designating a tag in the e-mail links.

Comment

In case of an email or brand override, this object won't work

  • Continue
  • Clicked
  • Not clicked

To determine whether one of more customers have opened (or not opened) the e-mail.

Follow up the openers or non-openers after a specified time (timer) based on a previously sent e-mail. For example, you could send a reminder e-mail to those who did not open the e-mail.


Comment

In case of an email or brand override, this object won't work

  • Continue
  • Opened
  • Not opened

To determine whether an e-mail sent to one or more customers has bounced.

Possibility to include the bouncers, non-bouncers, or other type of bouncers in a follow-up step within the campaign after a specific amount of time. For example, you could create an export of the bouncers for your customer service department.


Comment

In case of an email or brand override, this object won't work

  • Continue
  • Bounced
  • Not bounced
  • Hard bounced
  • Soft bounced

The ‘Apply Condition’ object sets a condition with which a fork in the path can be created.

A group of contacts that fulfils the condition follows a different path from the group of contacts that does not fulfil the condition.

Different follow-on objects can be defined for each of the two groups.

First give the condition a name. Then create one or more conditions by selecting a field. You can choose between a default customer field, a customer option field, a campaign field created during this campaign, or an environment field created during this campaign.

Then choose the condition (e.g. ‘is equal to’ or ‘starts with’). Choose the context of the value: ‘fixed’ (a fixed value such as a number) or ‘environment’ (an environment field from this campaign).

Finally, enter the value that the condition should compare with the chosen field. The value is case sensitive.

Comment

Click on the plus (+) icon to create a new condition.

In ‘Condition Criteria’, you can specify whether contacts should fulfil all conditions, or at least one of the conditions.

  • Continue
  • On match (fulfills conditions)
  • On fail (does not fulfill conditions)

The 'In Profile' object essentially functions the same as the 'Apply Condition' object. However, it checks if someone meets the conditions set in a profile.

It's important to specify when not to use it. The In Profile-object is not used to initiate a mailing. It does not select contacts within Deployteq.

You select the profile that someone needs to meet. This could be used, for instance, if someone completes a form (you have no control over the selection). You use the profile to check whether someone has placed an order in the past month and continue the flow based on the answer.

  • Continue
  • On match (matches conditions set in profile)
  • On fail (does not match conditions set in profile)

The 'Switch' object allows you to split customer selections based on customer data. The functionality is similar to (several) linked 'Apply Conditions', however this object is much more efficient.

Select the field you would like to use. You can use: Customer fields, Customer option fields, Campaign option fields and Environment fields. 

In the 'Value' column, enter the values you would like to use to split your customer selection. The should be values you can find in your Customer database (Screenshot Configuration).
In the 'Flow name' column, you can enter the name of the Link for each flow (optional). 

You can now create a link for each defined value. The 'Other' link will be used if the customer doesn't match with the given values (Screenshot in Campaign).

  • Continue
  • Other
  • Custom Created Links

The ‘Link to campaign’ object is used to direct customers in the current campaign to another campaign.Give the object a name. Select the campaign to which the contact should be added and specify with which ‘Start on Event’ the customer or customers should enter the campaign. For example, when someone has completed this campaign, they enter the next step of your customer journey. To prevent the campaign from getting too big, you can use this object to forward them to a new journey.
  • Continue

The ‘Split flow’ object is used to split a selection of contacts created previously into several directions.

First specify on what basis you want to split the contacts: 1. Split equally, 2. Split using a percentage, or 3. Split using a number. You can then enter the different flow names and configure the distribution. You will then see the flow names when linking the object to the next object.

Please note

This object only works when a selection passes through the object. If customers go through the object one by one (e.g. after completing a form), you will have to use a different solution. These are described in demonstration campaigns. 

  • Flow names as configured in the object

The ‘Checkpoints’ are used for Deployteq Analytics. When someone reaches a certain point in the campaign, this is counted in the checkpoint. You can then use these figures in your Analytics dashboard.Give the checkpoint a name so that you can find it in Analytics again.
  • Continue

The ‘Set timer’ object makes it possible to define a fixed time interval between different objects. A timer can be used, for example, to specify that an e-mail should be sent to a customer a day after the customer has subscribed.

Give the timer a name. You can then decide if you want to wait a specific number of days before the flow is continued or wait for a specific moment, e.g. wait until Monday or wait until 12:00 PM.

If you choose a period, you must set an interval: minute, hour, day, week, or month.

In ‘Offset’, enter the number of time units, e.g. wait 3 days.

The Timer object is triggered when a campaign flow reaches the object. The timer will schedule the next object in the flow to be executed with the specified delay.

If you change the settings of the Timer object in an active campaign, the new delay will be used from that moment forward. Objects that were already scheduled with a delay will retain their initially scheduled start time, and this will not be changed by adjusting the timer in the meantime.

Note: In an active campaign, you can adjust the set time of the timer, but the execution of objects that were already scheduled with the old settings will not be affected by this change.

  • Continue
  • On time (once timer has run down)

This object ensures that e-mails are only sent within specific times or that only a specific number of customers receive an e-mail per day. This allows you to limit the burden on your customer service department or, for example, refrain from sending e-mails on a Sunday if that is not what customers want.

Specify how many customers are allowed to pass through this object per hour, day, week, or month. You can then specify the days on which e-mails may be sent. Finally, you can also specify times between which e-mails may be sent, so that, for instance, your customers are not sent e-mails in the middle of the night by an automated process.

The ‘Continue’ exit will be used until the limit is reached. A signal is sent when the limit is reached and you can search for yourself via the ‘Limit has been reached’ exit to send yourself a notification e-mail. The customers who you can no longer send an e-mail to once the limit has been reached are directed through the ‘Past limit’ exit. These people can be placed in a group that is added to the flow again the next morning when the limit is reset.

  • Continue
  • Limit has been reached
  • Past limit


Customer Objects


IconFunctionSettingsExit

The possibility to export records that have entered a specific flow in a campaign. For example, you could export all bounced records daily so that they can be followed up by your customer service department.

Place a 'Bucket' object in front so that you can collect the customers first before exporting them, otherwise an export will be performed per customer.


Similar to when exporting data in the export module, you can then choose the fields that you wish to export and the location where you want to save the file.
  • Continue

This campaign object is used to configure an import as you are used to doing, but now the campaign will only continue once the import has finished. This object imports customers and select these customers within the campaign. Use the data model objects to perform a data model import.

You can also use these objects in succession.

This object takes you to Deployteq’s import wizard.
  • Continue
    • This exit contains all new and updated customer records
  • New customers
    • This exit contains all new imported customer records
  • Modified customers
    • This exit contains all updated customer records
  • On fail

This object can be used to unsubscribe customers from a campaign, all e-mail messages, and/or SMS messages.

You can unsubscribe a customer for:

  • Active Campaign: unsubscribe a contact from the current campaign.
  • All Future Mailings: unsubscribe a customer from all e-mail batches by setting Opt-in (e-mail) to ‘No’.
  • All Future SMS Batches: unsubscribe a customer from all SMS batches by setting Opt-in (SMS) to ‘No’.
  • Continue

This object can be used to modify customer data. This may be done in response to a customer action (e.g. clicking in an e-mail updates a field) or to add environment fields (e.g. a temporary value from an API call) to your contact database.

First give the object a name. Choose the field to which the new data should be added. Choose the ‘Fixed’ context value option, enter the value or environment (the value from this environment field), and select the environment field.

These values will be added to the selected database field for all customers that go through this object.

  • Continue

This object is used to identify a contact based on specific customer fields. The object searches your contact database for contacts that meet your specified criteria.

Give the object a name. Then select a customer field or customer option field from the list of fields. Now select an environment field in the drop-down menu.

The data from the customer database is now compared with the data from the environment field. You can specify multiple conditions.

  • Continue


This object is used to add a contact to the contact database or modify the data of an existing contact.

Similar to the ‘Add customer’ object, it is possible to add customers that enter a campaign via a ‘Start on Event’ or ‘Start on SMS’ to the database.

However, this object immediately assesses whether it is a new or existing customer record. It is also possible to deduplicate on the basis of one or more fields to prevent a contact from being included in the database several times.

In ‘System field’, you choose which Deployteq field you want to update and in ‘Context value’ you specify whether this value should be a fixed value or an environment value. Tick ‘Unique’ for the field on which deduplication should be based so that a check is made to see whether that field already exists in the database.

  • Continue
  • Existing customer
  • New customer
  • New and existing customer

The ‘Add customer’ object is used to add a contact to the contact database. Under normal circumstances, contacts are added to the database by means of an import or subscription form.

It is also possible to add contacts, which enter a campaign via a ‘Start on Event’ or ‘Start on SMS’ object, to the database. No deduplication will take place, but you can use the ‘Find customer’ object to check whether a contact already appears in the database.

On this basis, appropriate follow-up actions can be carried out. The default (e-mail) Opt-in value is ‘Yes’, while the default (SMS) Opt-in value is ‘No’.


Give the object a name. You then specify which (environment) variables should be saved in which customer fields. You can, for example, save an e-mail address from a URL parameter in a customer field belonging to this new record.

It is a good idea to place a ‘Find customer’ object in front so that you only add customers that do not yet exist and only modify other customers.

  • Continue

The ‘Delete customer’ object can be used to delete a contact from the database. This is useful if you only want to keep a contact in your database temporarily (e.g. for Forward-to-a-friend campaigns).

This action cannot be undone.

By default, this object deletes customers in a single customer flow only. In the settings you can choose to delete several customers simultaneously.

Tick a checkbox in the object settings to allow multiple customers to be deleted simultaneously.
  • None

This object is used to select a group of contacts based on the current campaign, profile, or group. The group that is selected proceeds to the next step in the campaign.

Enter a name for the object. Then choose whether you want the selection to be made on the basis of the current campaign, a group, or a profile. If you opt for a group or profile, select the desired group or profile in the file manager. 

You can choose from all groups and profiles that were created in the 'Profiles' and 'Groups' components in Deployteq. In the CRM, you can make contacts members of a campaign, such as for an import.

  • Continue

This object can be used to add selected contacts to a group in the campaign.

Give the object a name and select the group to which the contacts should be added. You can choose from all existing groups. You can also choose to create a new subgroup of the chosen group. Check the box for ‘Create new group’. Here you can also use variables such as ‘$smarty.now’ or ‘manual field’.

  • Continue

You can delete selected contacts from a group in the campaign.

Give the object a name and select the group from which the contacts should be deleted. You can choose from all existing groups.
  • Continue

With this object, it is efficient and easy to set up to compare the current customers in a group with the customer selection of the campaign flow every time the campaign runs, and to update all differences. If a group customer is not present in the incoming selection, they are removed from the group, and if a selected customer is not present in the group, they are adde

Use this object to easily capture the customer selection in a campaign and store it in a group.

After dragging the object into your campaign, you can customize its name. Then, you select the desired group to be synchronized. You can choose from all groups created in the 'Groups' section of Deployteq.

The object before the 'Sync to Group' object in the campaign flow should be the 'Select customers' object. With this object, you select a group of relationships based on the current campaign, profile, or group. The group selected moves on to the Sync with Group step.

  • Continue

Encrypt customer data so that it can be used securely, such as in a URL. This enables you to follow a customer, prefill forms, or create a soft login.Specify the fields that you want to encrypt and then the encryption method you want to use underneath. All encryption options can be found on a seperate page in this manual.
  • Continue




Environment Objects


IconFunctionSettingsExit

Global Environment

This object makes it possible to insert temporary variables throughout the path, which only apply inside the campaign.

This object can be used, for instance, as a counter within a path.

First give the object a name. For the field name, select an existing environment field or enter a new name to create a new field.

In ‘Field Option’, select the type of action. Then define the field value, such as ‘Counter’ (field name) ‘increase by’ (field option) ‘1’ (field value). The object will now ensure that the counter is increased by 1 for every contact that passes the object.

Elsewhere on the path, the counter can be reused in a condition, e.g. ‘Counter’ (field) ‘is’ (condition) ‘500’ (fixed value). The contact that makes the counter tick over to 500 fulfils this condition.

  • Continue

Private Environment

The ‘Private Environment’ object is virtually similar to the ‘Global Environment’ object. The difference is that ‘Private Environment’ only applies to active users.

It allows you to define variables at individual level that you can reuse further on in a campaign path to link conditions, for example, or to save specific values to customer records.

In a private environment, you can also first give the field a name. You then specify what you want to do with this field. Again, you can enter a value, increase or decrease, or enter a value before or after.

However, in a private environment, this will be a personal value. Whereas a counter is used for the entire campaign in the global environment, here you can count how many times a person has passed through a specific flow. For example, a person is allowed to receive a reminder twice. You increase the counter to 1 after sending the first reminder and then increase by 1 again after the second reminder. The condition then checks whether the counter is greater than 1. If it isn’t, the customer is allowed to receive another reminder and if it is, the customer will leave the flow. The customers who are in the flow can all have a different value in their private counter.

  • Continue


Other Objects


IconFunctionSettingsExit


Bucket

This is used to collect customer records in a campaign flow and is often used to export customers in the campaign flow. In this way, you don’t have to

create an export for each customer who goes through the flow.
You configure the threshold value based on a specific period of time or number. The customer records are collected until the threshold value is reached, e.g. you collect the participants until a specific number is reached. When the threshold value has been reached, you can take follow-up steps, such as sending a bundled e-mail or sending an export to the customer service department.
  • Continue
  • Threshold reached

Extract Value

When you have JSON code in an environment variable or customer field, this is normally read out as text, which means that you cannot do much with the values in your JSON code. This object can be used to save the values in your code as separate elements in a field or as a separate environment variable.

Specify where the code is saved; the type has always been JSON up to now. Then specify the path where the value that you want to use can be found, e.g. order.orderNumber and specify where you want to extract it to under ‘System field’.


A value within an array

It's also possible to obtain a value within an array, see the example below:

order.0.orderNumber

  • Continue
  • On success
  • On fail

Landing Page

This object makes it possible to direct users to an external page, e.g. a page on your website, based on a specified URL.

You have the option to use GET variables to enclose customer data in the URL of the external page.

Give the object a name. Then specify the URL to be used. If desired, you can set (GET) variables to include customer data in the URL.

Please note!

Customer data must not be identifiable in the URL due to privacy reasons. We therefore provide the option to encrypt customer data, so that it becomes unreadable for visitors.

  • Continue

HTTP request

The 'HTTP Request' object allows you to communicate activities to external systems or retrieve data from external APIs.

Sending Data
If you want to send data to an external system, for example, a customer who has signed up and needs to be sent to your CRM system, you can send customer/campaign/environment/static data using:

  • Query parameters in the URL
  • The header of the message
  • JSON or x-www-form-urlencoded structure in the body of the message
    • You can use a Deployteq interface to easily add fields to the body or choose the option of a Raw body, where more complex actions can be performed using Smarty. This object allows you to send a request per customer or a selection of customers in a single message.

Retrieving Data
If you want to retrieve data, you can use a GET request to fetch the external data, which can then be processed within the campaign and/or with the webhook receiver.

Response Data
The HTTP response code and data received by Deployteq from the system are made available in a private environment variable within the campaign.

To configure this object you can follow these steps:

  1. Determine the desired HTTP method: GET, POST, PUT, HEAD, PATCH, or DELETE.
  2. Identify the authentication requirements of the external system, such as API keys, tokens, or authentication headers. Ensure you have the necessary credentials.
  3. Set the headers and parameters required for the request. These can be specified according to the external system's API
  4. Obtain the endpoint or URL of the external system. This is the specific address where the API is located.
  5. For POST, PUT, or PATCH requests, choose the appropriate content type for the payload:
    1. 'application/x-www-form-urlencoded' for RAW content
    2. 'application/json' for a body containing JSON.
  6. Configure the required body data by using the Deployteq interface or customize the body by using Smarty to include any specific data or perform complex actions.


One message per selection or individual customer.

In the case that no customer fields are set in the HTTP Request object and/or no Smarty is used in the body of the message, the HTTP request will be executed once per selection to the configured URL.

If you have included a customer field in the settings of this object, a request will be sent to the configured URL for each customer. The object has a limitation of 1,000 requests to an endpoint per selection provided in the object. You can address this by setting a "Random" condition in your profile or including a Split Flow object in your campaign based on a fixed number.

If you wish to send the information of a selection of customers to the configured URL with a maximum of 10,000 customers per message, a specific Smarty solution called $customerSelection is required.

HTTP response in environment variables

The response and code of the HTTP request are made available as environment variables:

  • request_code: This variable contains the HTTP response code received from the system.
  • request_response: This variable holds the data or response received from the system.


You can access and use these environment variables within your campaign to process or utilize the response data as needed.

IPv4 VS IPv6

This object only supports URLs based on IPv4.

  • Continue
  • On match
  • On fail

Set Error

You can enter an error message in the campaign. This is used, for instance, for a login process when the authentication fails.

Give the object a name. Enter a text to be displayed as the error message. This can then be displayed on your page using the Smarty code {{error}}.
  • Continue

Confirm Relation

The ‘Confirm Relation’ object confirms the relationship between two persons, brought about, for example, by a Forward-to-a-friend form. 

This confirmation follows automatically when, in the case of the Forward-to-a-friend form, the e-mail sent to the subscribed friend is clicked on.

No configuration is necessary for this object
  • Continue

Import From URL

When the webhook is configured in the store, the "Import from URL" object becomes available. With this object, you can retrieve and process an XML, RSS, or JSON feed through a webhook into the datamodel.

This object allows you to, for example, store a product feed in the data model so that it can be easily used in your content.

Because this data is stored in the datamodel, you also benefit from the maximum delivery speed compared to the solution where a feed is fetched when rendering an email (Datafeeds app).

The only downside of this object is that you can't use a personalised feed.

In the object, you can specify the URL of the feed and the webhook that should process the data. After the feed is initially retrieved and provided to the webhook, the data can be linked or associated.

* This object can only handle fixed URLs; dynamic url's with personal information isn't possible.


Below is an example campaign in which the feed in the data model is refreshed daily: