Overview
The Custom API node lets you connect Sense with external systems that your team already uses, such as background checks, e-signature platforms, scheduling tools, spreadsheets, chat applications, and push notification services. You can then interact with these systems directly from your workflows.
The Sense team configures the Connector required to connect Sense with the external system. This includes the Connector's authentication, endpoints, and event-listening configuration, when applicable.
Once the Connector is configured, you can select it in a Custom API node and use its available endpoints in your workflows. You don't need to enter or manage API credentials or configure the Connector yourself.
Connector configuration
The Sense team configures the following as part of the Connector setup:
- Authentication — Establishes how Sense authenticates with the external system.
- Endpoints — Defines the API operations available to workflows.
- Event Listening — Configures event listening when supported by the integration.
Authentication types
Sense supports the following authentication types for Connectors:
| Authentication type | Use it when |
| No Authentication | The external API does not require a separate authentication step, or uses a static token configured by the Sense team. |
| Session Authentication | The external API requires Sense to log in first, obtain a token, and use that token for subsequent requests. |
Note: Authentication is configured on the Connector, not on the Custom API node. When you use a Connector in a workflow, the Custom API node automatically uses the authentication configured for that Connector.
Use an authenticated Connector in a Workflow
After the Sense team configures and saves a Connector, you can use it in your workflow without configuring credentials again.
To use a Connector:
- Add a Custom API node to your workflow canvas.
- Select the Connector you want to use, such as Add WorkN.
- Select an endpoint from the Connector's saved endpoints, such as POST /notifications/send.
- Review the full URL shown for confirmation.
- Map your workflow variables to the API request using {{ }} placeholders. For example, you can map the candidate ID or message body.
- Click Test to make a live API call and verify the response, such as 200 OK.
- Save the node to the workflow.
What Sense sends
Sense automatically adds the authentication information configured on the Connector to the API request.
For example:
- Session Authentication: Sense adds the session token, such as Authorization: Bearer {token}.
- No Authentication: Sense sends the global headers configured on the Connector.
You don't need to paste credentials into the Custom API node.
What Sense receives
Sense parses the JSON response returned by the external system. Each response field becomes a downstream variable that you can use later in the workflow.
For example, you can use the returned values in:
- Email or SMS messages
- Field writebacks
- Conditions and branch logic
| Variable | Example value |
| {{api.status_message}} | push notification scheduled to send |
| {{api.audit_id}} | 2757711570 |
Example: WorkN
After the Sense team configures the WorkN Connector, a workflow can use a Custom API node to call WorkN and send a push notification to a candidate.
When the API call succeeds, WorkN returns a response such as:
{
"status_code": "200",
"status_message": "push notification scheduled to send"
}
The workflow can then use these response values as downstream variables and continue to the next step.
You don't need to enter the WorkN token again in the workflow. The Custom API node automatically uses the session token configured on the Connector.
How authentication works
Authentication is configured once on the Connector by the Sense team. Every endpoint configured on that Connector uses the same authentication setup.
You don't need to configure authentication separately for each workflow, endpoint, or Custom API node.
For Session Authentication, Sense:
- Calls the login endpoint using the configured credentials.
- Reads the token from the login response.
- Stores the token securely.
- Adds the token to subsequent API calls made through the Connector.
- Refreshes the token when needed.
For No Authentication, Sense uses the global headers configured on the Connector when making API calls.
FAQs
Do I need to configure the Connector?
No. The Sense team configures the Connector, including authentication, endpoints, and event listening when applicable.
Which authentication types does Sense support?
Sense currently supports No Authentication and Session Authentication.
Do I need to configure authentication on every Custom API node?
No. Authentication is configured once on the Connector. Every workflow and Custom API node that uses that Connector automatically inherits its authenticated connection.
Do I need to enter API credentials in the workflow?
No. The authentication details configured on the Connector are automatically used when the Custom API node makes the API call.
Can I use the same Connector in multiple workflows?
Yes. Once configured, the Connector can be used by multiple workflows across your agency.