TRMNL Octri Demo
POST/api/plugin_installations/{plugin_installation_id}/connections/{connection_id}/attempts

Start provider authorization for a plugin installation connection

Starts provider authorization for a specific connection on a plugin installation. Supply action_id, revision, and callback_id; callback_id must be companion. Use the returned attempt details to continue the authorization flow; launch_url is returned only when the attempt is created.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

2 parameters · 3 body fields
plugin_installation_idstringrequired
The identifier of the plugin installation for which to start provider authorization.
connection_idstringrequired
The identifier of the exact connection target to authorize.

Provider authorization attempt details.

action_idstringrequired
The identifier of the action to authorize.
callback_idstringrequired
The callback type for the authorization flow; must be `companion`.
Allowed:companion
revisionstringrequired
The configuration revision associated with the authorization request.

1 status code
201Returns the created attempt details, including its identifier, state, expiry time, connection identifier, and target. The `launch_url` is returned only when the attempt is created.
dataobjectoptional

Error handling

action_id, revision, and callback_id are required, and callback_id must be companion. The plugin_installation_id path parameter must identify the plugin installation, and the connection_id path parameter must identify the exact target connection.