Hanzo AI
OpenapiProvider

Create poll

Advances a device sign-in. Terminal outcomes are DATA, not errors (verifyConn {active:false} discipline) — the status set is closed:…

POST /v1/connection/{provider}/device/{flow}/poll

Addresshttps://api.hanzo.ai/v1/connection/{provider}/device/{flow}/poll
MethodPOST
Operationpost_connection_by_provider_device_by_flow_poll
AuthAuthorization: Bearer $HANZO_API_KEY

Advances a device sign-in. Terminal outcomes are DATA, not errors (verifyConn {active:false} discipline) — the status set is closed: pending|connected|denied|expired. pollSlow collapses to "pending" on the wire; the raised cadence rides interval.

Request

2 fields.

FieldInTypeRequiredDescription
providerpathstringyesProvider is the user-scoped provider's registry id, from the path.
flowpathstringyesFlow is the id deviceStartOut returned.

Response

StatusBodyMeaning
200provider.devicePollOutok
defaultproblem-detailsrefused

200 body — 11 fields.

FieldInTypeAlwaysDescription
connectorbodyprovider.connectionView
connector.accountbodystringAccount is the human label of the connected third-party account (the Slack team name, the GitHub org login).
connector.connectedAtbodystringConnectedAt is when the connection was last (re)established, RFC 3339 UTC.
connector.expiresAtbodystringExpiresAt is when the access token expires, RFC 3339 UTC; empty for a credential that does not expire.
connector.externalIdbodystringExternalID is the provider's own id for the account (Slack team.id, GitHub installation_id) — the value inbound webhooks are mapped back to this org by.
connector.idbodystringID is provider + ":" + label, the address every connection route takes.
connector.labelbodystringLabel is the caller's own name for this connection ("default", "work").
connector.providerbodystringProvider is the connected provider's registry id.
connector.scopesbodystring[]Scopes are the permissions the provider granted.
intervalbodyinteger (int64)Interval is the seconds to wait before the next poll.
statusbodystringStatus is the flow's state.

Failure carries the platform error shape — see Errors.

Examples

hanzo connection device poll <provider> <flow>

Provider API · All Hanzo APIs · Interactive reference

How is this guide?

On this page