Sign in
Agents

Create an agent integration

Create a link between an agent (by identifier) and an integration (by integration identifier, not the internal _id).

post/v1/agents/{identifier}/integrations

Path parameters

identifierstring required

Request body

integrationIdentifierstring

The integration identifier (same as in the integration store), not the internal document _id.

providerIdstring

Provider ID to auto-create a dedicated integration (e.g. novu-agent-email). When set, the server creates the integration if one does not already exist for this agent.

Response

Created

_idstring required

Agent–integration link document id.

_agentIdstring required
_environmentIdstring required
_organizationIdstring required
connectedAtobject nullable

Set when the agent–integration link received its first inbound webhook delivery.

createdAtstring required
updatedAtstring required
exceedsPlanLimitboolean

Cloud only. true when this channel type (provider) falls outside the organization plan active-channel limit (by connection order). Active channels are counted per channel type, so multiple integrations of the same provider (e.g. several Slack workspaces) count as a single active channel. Over-limit channels keep their configuration but the agent will not respond on them until the plan is upgraded or older channel types are disconnected.

Changes

Changed in 1 of the 13 revisions of this API.1