API Reference

The NexLink API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

The NexLink API uses API keys to authenticate requests. You can view and manage your API keys in the NexLink Dashboard. Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas. All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.

POST /v1/messages Send a message to a user via a specific channel. Parameters: • agent_id (string): The ID of the agent sending the message. • channel (string): The platform (e.g., 'whatsapp', 'instagram'). • recipient (string): The user's phone number or ID. • text (string): The message content.

GET /v1/conversations/{id} Retrieve the transcript of a specific conversation. Returns a conversation object containing the status, participant details, and an array of message objects.

NexLink uses webhooks to notify your application when an event happens in your account. Webhooks are particularly useful for asynchronous events like when a customer requests human handoff (`handoff.requested`) or when a new lead is qualified (`lead.qualified`). You can configure webhook endpoints in the developer settings.