NOnovu
Agents

Create an agent integration

Changed on

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

post/v1/agents/{identifier}/integrations

Request

  • Base URL
    https://api.novu.co
  • Auth
    API key in header Authorization

Path parameters

identifierstring required

Headers

Novu-Analytics-Sourcestring required
idempotency-keystring

A header for idempotency purposes

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.

hasChannelEndpointsboolean

true when at least one person has linked their chat on this integration (it has a channel endpoint), so the agent has someone to reach there. Only returned by the list, and only when true. Email has no channel endpoints, so it never carries the flag.

Changes