Google inbound routing

Point this agent's Google traffic at your own endpoint

This is Google's inbound routing for one agent — it is not how you receive messages from Cadence. It tells Google to push this agent's traffic to a URL of your own instead of to the partner-level endpoint that Cadence normally receives on, which means Cadence stops seeing that agent's replies and stops driving its flows.

If what you want is your application to learn about inbound replies, you want a flow (the server answers for you), GET /v1/events (SSE), or GET /v1/conversations/{id}/answers (polling) — see the guide at https://cadencercs.com/docs.html#receiving.

We issue the verification token rather than accepting one, so it is always high-entropy. It is derived, not stored — re-issuing returns the same value; ?rotate=true invalidates the old one. Your endpoint must echo the token on Google's verification handshake, and every push is signed with it.

put/v1/agents/{id}/webhook

Request

  • Base URL: https://api.cadencercs.com
  • URL: https://api.cadencercs.com/v1/agents/{id}/webhook
  • Auth: HTTP bearer

Path parameters

idstring required

Agent id.

Query parameters

rotate'true' | 'false'

true bumps the token version, invalidating the previous token.

Request body

webhookUristring required

A public https:// URL. Google posts to it directly.

Response

Configured. The token is shown once.

okboolean required
webhookUristring required
integrationIdstring
verificationTokenstring required

Shown exactly once, for the same reason an API key is.

nextStepstring
ourEndpointstring

Point Google here instead if you would rather Cadence keep receiving.

notestring

Changes

No recorded changes to this operation across all 1 revision of this API.