Already have a backend that does the work? Custom API actions let your Recurly Engage prompts call it directly, passing along user data and securely stored credentials.

Available on all Recurly Engage plans

1Definition 2Key benefits 3Key details

Prerequisites

You must have Company or App Administrator permissions in Engage.

Definition

Custom API actions let you call external backend endpoints from prompts, using dynamic user data and secure credentials.

Key benefits

Build on existing systems Integrate with your own APIs without additional development in Engage.

Secure and dynamic Store credentials securely and inject user-specific data into API calls.

Flexible configurations Define URLs, methods, headers, query strings, and payloads for diverse use cases.

Key details

You can define custom API actions to use your existing backend endpoints, sending dynamic user data and secure credentials as needed.

Add credentials

Credentials data is stored in a secure, encrypted location that is only accessible to components tasked with performing the action. The most common credentials are API keys and client secrets.

Add a new credential and specify its name and value.

Add actions

Define a custom API action by specifying the URL, HTTP method, request headers, query string, and request payload (if necessary).

Engage supports static and dynamic values. Use the special character (%) and placeholders to inject dynamic user data. You can reference placeholders like %provider.api_key% or %provider.client_secret%, user traits ingested via Engage, and form inputs. Dynamic values work in URLs, payloads, headers, and query strings.

NotePayloads don't support complex JSON structures — only a single level of key-value pairs.