Skip to main content

Callout flows

Simon Walsh
  • Updated
Pendula currently only supports Notifications from Zuora with callout flows. Keep an eye out for further integrations coming soon!

Follow the Pendula Updates topic in the Community to stay up to date on our latest releases.

Callout flows are similar to event flows, but are triggered by a callout or webhook from an external platform. This allows Pendula to trigger communications based upon events or data in platforms outside of Salesforce.

Examples include sending out payroll reminders from a HR/accounting system or an order confirmation from a subscription or billing service.

 

Quick links

Zuora notifications

How to generate an API token

How to create a callout flow

Adding a callout url path

Who are you sending it to?

Callout merge fields

Considerations when using callout flows

 

Zuora notifications

Callout flows are triggered by notifications from Zuora.

Unlike an event flow, any criteria or rules regarding when a callout flow should trigger are dictated by the event which triggers the notification within Zuora, this is then passed to Pendula to action any subsequent communication or actions.

Please see Create and Edit Notifications and Configure Callout Notifications within the Zuora Knowledge Centre for more information.

 

How to generate an API token

In order to enable sending callouts to Pendula successfully, you'll need to generate an API token within the Pendula Settings screen.

  1. Navigate to the Pendula Settings screen by clicking on the avatar icon in the top-right hand side of the app, and then select Pendula Settings

  2. Scroll down to the Generate API token section

  3. Enter a name into the Token name field, then click Generate new token

  4. The token will be generated with a Tenant ID and an API token value. You will need to copy and save these values securely and acknowledge this before being able to select Ok.

    Once generated, you won't be able to view the API token value again!

  5. You'll use your newly generated API token value as the Callout Authentication password within Zuora when configuring your callout notification.  

Once your token has been generated you can start creating your callout flow within Pendula.

If you forget your API token's details, or need to cancel an existing token you can do this within the Generate API token section. A Pendula tenant can have multiple working tokens without any issues.

 

How to create a callout flow

  1. Navigate to the Flows tab and click on the New Flow button

  2. Name your flow and if helpful, provide an optional description

  3. Set the Data source to Zuora and Related object to the relevant object the flow is regarding

  4. Under When will it trigger? select On a callout

You'll then be able to configure your callout url path.

 

Adding a callout url path

  1. Enter a unique URL path (for example, InvoicePosted) into the Add callout URL path field. You will see this path append to the Callout URL field

  2. Copy this URL, then login to your Zuora environment and follow the instructions for creating a notification which will hit this URL

  3. You can select Configuration Options for Zuora beneath the Callout URL field to see the relevant details you will need to configure on the corresponding notification within Zuora

 

Who are you sending it to?

This section allows you to further filter recipients once a notification from Zuora has triggered the flow.

This section is optional for callout flows, so you don't need to add any criteria here to segment your recipients further if it is not required.

You can add criteria that will evaluate the record included in the callout from Zuora, based on information residing on your related object and the objects related to it.

  1. To set a rule, firstly either search for (or browse) and select the relevant field name from the Field dropdown. These fields coincide with any objects which share a one-to-one relationship with the related object you have selected for your flow, along with the related object itself

  2. Select the desired Operator and Value to complete your rule

  3. Click on the Add rule button to further segment recipients. Adding more than one rule also allows you to specify whether the flow should trigger based on all or any of the rules outlined

  4. You can also create a group of rules by clicking on the Add group button. Once more than one rule is added to a group, you can apply an all or any to your group of rules. This allows you to nest a series of any statements within your all statements, for example all Invoices with a status equal to Posted, and with the Bill to Contact State equal to either NSW OR QLD.

See Flow criteria for more information on creating rules and groups.

 

Callout merge fields

If you have nested fields within your callout from Zuora, Pendula can include these as merge fields providing the field type is:

  • String
  • Boolean
  • Number
Callout merge fields are unable to be used with date_fmt or num_fmt dynamic operators.

If referencing a nested field within a template, you'll need to use the following syntax:

{{ @event.<fieldName> }}

For example, if referencing an AccountNumber field in a callout merge field, the syntax would be:

{{ @event.Account.AccountNumber }}

 

Considerations when using callout flows

  • Pendula can only trigger callout flows based on the available notification events supported by Zuora. You can view the full list here.

  • Pausing a callout flow will queue any callouts received from Zuora. This means if the paused flow is reactivated, these events will then subsequently trigger the flow. If you don't want this to occur after pausing a flow, consider terminating it and then activating a copy of this flow. See Managing existing flows for more information.

 

Related articles