RevoplyAIDocs
API reference

API reference

The machine-readable contract generated from the OpenAPI specification, with the flow trigger endpoint and every webhook event.

View as MarkdownOpen in ChatGPTOpen in Claude

The pages in this section are generated from the OpenAPI 3.1 specification (download), so they match what the API does.

What it contains today:

  • POST /hooks/{token}: the endpoint your system calls to start a flow. Its token is its credential, so this page has no in-browser console: call it from your server. The guides are under Flow triggers.
  • Every webhook event we send to your endpoints, with its fields and an example.

What it does not contain yet: the REST API (https://api.revoplyai.com/v1) for reading contacts and conversations and sending messages is not available. Its endpoints, API keys and in-browser console will appear here when it is published, and the changelog will announce it.

Hand over to a human

Open a ticket in your helpdesk when the assistant hands a conversation to your team, using the conversation.handover event.

Start an automation POST

Starts the flow this hook belongs to for the customer your JSON names, by the paths set in the flow's trigger.