Custom activities are used in automations to post selected contact attributes to an external API, for example to trigger communication that is not managed from Voyado Engage. The functionality is similar to a webhook.

Configuration

Your Voyado specialist will need to create a custom activity for you. For that, you will need to suply the URL of your endpoint, the authentication scheme (basic, bearer, API key or Voyado API), and the list of attributes that should be sent in the payload. You can read more about attributes here.

Limitations of custom activities

• If the receiving party isn’t “answering” then Engage will retry for a total of 10 times before it drops the request. Information about this is not visible anywhere in Engage.
• There is no throttling on the Engage end; the request is processed as quickly as possible.
• Engage performs no data transformation of the payload and just passes it on. The receiving party must build an endpoint to handle whatever form the data is in.
• If Engage receives an error from the external system at any stage of a custom activity workflow, the workflow for that contact will just be ended at that point.

Payload example

Here is an example of the payload generated by a custom activity. This example includes 7 attributes and this results in a flat structure payload containing the attributes with its values.

Depending on type of schema (if chosen) we will include the authorization type for the request in the headers_http_authorization field.

{
   "headers": {
       "Accept-Encoding": "gzip,deflate",
       "Expect": "100-continue",
       "Host": "prod-51.northeurope.logic.azure.com",
       "Newrelic": "eyJ2IjpbMCwxXSwiZCI6eyJ0eSI6IkFwcCIsImFjIjoiMzIyNDQ2IiwiYXAiOiIyMTU1MDE4IiwidHIiOiIxOTgzMkZBQkY4RTI5RUQ4IiwicHIiOjAuMjU1MDA4LCJzYSI6ZmFsc2UsInRpIjoxNjAyNTAzOTQ1NDM0LCJ0eCI6IjE5ODMyRkFCRjhFMjlFRDgifX0=",
       "Content-Length": "142",
       "Content-Type": "application/json; charset=utf-8",
       "headers_http_authorization" : "Apikey superSmartKey"
   },
   "body": {
       "firstName": "Morran",
       "lastName": "Mumin",
       "street": "Muminstreet 3",
       "zipCode": "83752",
       "city": "Muminland",
       "email": "mumin@muminland.com",
       "bonusPoints": "36165866,0000"
   }
}

Article last reviewed 12 March 2026 09:54