sales_engagement_read
sales_engagement_read forwards a read request to whichever sales engagement platform
your tenant has connected. OnFire resolves the integration and its stored
credentials internally — there is no integration_id argument and you
never handle auth.
Provider discovery comes first
Section titled “Provider discovery comes first”The same business object has a different resource name on every provider:
Outreach and Salesloft call them “sequences” and “cadences”, Gong calls
them “flows”. Authoring a path from memory is the leading cause of a 404
routeNotFound.
Call get_tenant_settings, read
settings.sep.type, and use that provider’s resource names. Re-check
whenever you switch tenants inside a conversation.
Inputs
Section titled “Inputs”| Parameter | Type | Required | Description |
|---|---|---|---|
relative_url | string | Yes | API path relative to the provider API root — never repeat the root. |
http_method | string | No | GET (default) or a read-shaped POST. |
json_body | object | No | Body for read-shaped POSTs. |
params | object | No | Query-string parameters. |
Path rules
Section titled “Path rules”| Provider | API root | Example relative_url |
|---|---|---|
| Outreach | api/v2/ | sequences, prospects |
| Salesloft | v2/ | people, cadences |
| Gong | v2/ | flows |
| Reply.io | v3/ | sequences, contacts |
Read-only enforcement
Section titled “Read-only enforcement”Any GET, plus read-shaped POSTs (search, batch/read,
associations/.../batch/read). Anything else is redirected to
sales_engagement_write or rejected.
Returns
Section titled “Returns”JSON with status (success / target_http_error), status_code, and
content.
Notes & limits
Section titled “Notes & limits”- Scoped to your own tenant’s SEP integration.
- Present operations in business terms — never surface API paths, methods, or vendor names to the user.