Available to Organization Admin.
Introduction to API Action
An API Action is a Workflow Step that sends a request to another system's API when a Project reaches it. Use it to bring other services into Leap Project's workflow: they take action at exactly the right step, such as posting to Slack when a deal is won, or processing the workflow file in an external service, with no manual handoff.
Every API Action has two sides:
-
The receiving system provides an address (URL) to call and a way to authorize the call, for example a Slack webhook URL, an API key, or your Salesforce connection.
-
Documill Leap holds the request definition as an API Action Template. Organization admins create templates, and Project Owners add them to a workflow as an API Action Step.
Before you start
You need the details of the API you want to call: its URL, HTTP method, expected request body and how it is authorized.
To call Salesforce with the Use Salesforce connection option, your Leap Organization must first be connected to Salesforce. See Giving your Leap Organization access to Salesforce .
Keep these limitations in mind when you plan an API Action:
|
Limitation |
What it means |
|---|---|
|
HTTPS only |
With Custom authorization, the URL must start with |
|
Public addresses only |
The URL must point to a public internet address. Addresses inside a private network, such as |
|
Fixed URL |
The URL cannot contain parameters. Values that change per Project must go in the request body. |
|
Parameters in the request body only |
Parameters such as |
|
5-second time limit |
The receiving system must respond within 5 seconds, or the call is treated as failed. |