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
| Address | https://api.hanzo.ai/v1/connection/{provider}/device/{flow}/poll |
| Method | POST |
| Operation | post_connection_by_provider_device_by_flow_poll |
| Auth | Authorization: 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.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
provider | path | string | yes | Provider is the user-scoped provider's registry id, from the path. |
flow | path | string | yes | Flow is the id deviceStartOut returned. |
Response
| Status | Body | Meaning |
|---|---|---|
200 | provider.devicePollOut | ok |
default | problem-details | refused |
200 body — 11 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
connector | body | provider.connectionView | — | |
connector.account | body | string | — | Account is the human label of the connected third-party account (the Slack team name, the GitHub org login). |
connector.connectedAt | body | string | — | ConnectedAt is when the connection was last (re)established, RFC 3339 UTC. |
connector.expiresAt | body | string | — | ExpiresAt is when the access token expires, RFC 3339 UTC; empty for a credential that does not expire. |
connector.externalId | body | string | — | ExternalID 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.id | body | string | — | ID is provider + ":" + label, the address every connection route takes. |
connector.label | body | string | — | Label is the caller's own name for this connection ("default", "work"). |
connector.provider | body | string | — | Provider is the connected provider's registry id. |
connector.scopes | body | string[] | — | Scopes are the permissions the provider granted. |
interval | body | integer (int64) | — | Interval is the seconds to wait before the next poll. |
status | body | string | — | Status is the flow's state. |
Failure carries the platform error shape — see Errors.
Examples
hanzo connection device poll <provider> <flow>import { Configuration, ProviderApi } from 'hanzoai';
const api = new ProviderApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.postConnectionByProviderDeviceByFlowPoll({ provider: 'provider', flow: 'flow' });from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import ProviderApi
client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = ProviderApi(client).post_connection_by_provider_device_by_flow_poll(provider='provider', flow='flow')cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)
resp, _, err := client.ProviderAPI.PostConnectionByProviderDeviceByFlowPoll(context.Background()).Execute()
if err != nil {
return err
}use hanzo_client::apis::{configuration::Configuration, provider_api};
let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();
let result = provider_api::post_connection_by_provider_device_by_flow_poll(&cfg, Default::default()).await?;import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.ProviderApi;
ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));
var result = new ProviderApi(client).postConnectionByProviderDeviceByFlowPoll();The method above is the one at the current release of the document. [email protected] (npm) and [email protected] (PyPI) were generated from an earlier release, where this operation carried a different id, so it spells the method differently — regenerating the clients is what makes the two agree. SDKs →
curl -X POST https://api.hanzo.ai/v1/connection/<provider>/device/<flow>/poll \
-H "Authorization: Bearer $HANZO_API_KEY"MCP declares no tool for provider — tools/list on https://api.hanzo.ai/v1/mcp names the products it does reach. Use HTTP or an SDK.
How is this guide?