API reference

Destinations API

Where captured leads and events are sent: connect a provider, choose which events it receives, or remove it.

Endpoints

4 operations, each with its parameters, schemas and an example request on its own page.

get/api/destinationsList destinations — What is connected, and what could be.
delete/api/destinations/{connection_id}Remove a destination
put/api/destinations/{connection_id}/eventsChoose a destination's events
post/api/destinations/{provider}/connectConnect a destination

Authentication

Every call here needs Authorization: Bearer with a key from the dashboard — Authentication covers keys and scopes.

Objects returned

The models these endpoints send back, with every field. Open one to read it.

Message2 fields

messagestringrequired
okboolean
Default: true

ConnectResponse2 fields

authorization_urlstringrequired
providerstringrequired

Something here wrong or missing? Tell us — the documentation and the API are maintained by the same person, so a correction is a fix rather than a ticket.