Register an external messaging adapter

post/v0/city/{cityName}/extmsg/adapters

Request

  • The document declares no server URL.
  • Auth: none declared. Required headers: X-GC-Request

Path parameters

cityNamestring required

City name.

Headers

X-GC-Requeststring required

Anti-CSRF header required on mutation requests. Any non-empty value is accepted; the header's presence is what the server checks.

Idempotency-Keystring

Idempotency key for safe retries.

Request body

account_idstring required

Account ID.

callback_urlstring

Callback URL for outbound messages.

namestring

Adapter display name.

providerstring required

Provider name.

Response

Created

account_idstring required

Account ID.

namestring required

Adapter name.

providerstring required

Provider name.

statusstring required

Operation result.

Example response

{
  "status": "registered"
}

Changes

No recorded changes to this operation across all 50 revisions of this API.