Dynamiq
End User Requirements

Submit credentials for a requirement

Submits connection credentials that satisfy a `connection` requirement for the token's user. The submitted `type` must match the connection type declared in the requirement's spec. OAuth2-based connection types are rejected — use the OAuth2 authorize endpoint instead. On success an active end-user connection is stored and the requirement becomes `completed`. Served on the management API; authenticate with a connect token.

POST
/v1/connect/requirements/{requirement_id}/credentials

Authorization

connectToken
AuthorizationBearer <token>

Short-lived Connect token identifying a single end user of a single app. Created with POST /v1/connect/tokens on the deployed app's hostname and valid for 24 hours. Accepted only by the /v1/connect/* requirement-fulfillment endpoints on the management API — it is distinct from Access Keys and Personal Access Tokens and grants no other API access. Send as Authorization: Bearer <connect-token>.

In: header

Path Parameters

requirement_id*string

Requirement UUID.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Credentials submitted to satisfy a connection requirement.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/connect/requirements/497f6eca-6276-4993-bfeb-53cbbbba6f08/credentials" \  -H "Content-Type: application/json" \  -d '{    "type": "dynamiq.connections.HttpApiKey",    "config": {      "url": "https://helpdesk.example.com/api",      "api_key": "hd_live_9f3a7c1e2b54"    }  }'
{
  "message": "created"
}
{
  "error": {
    "code": "bad_request",
    "message": "Bad Request",
    "details": {
      "input": "cannot be blank"
    }
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}
{
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}

Get requirement statuses

Lists the end-user requirements of the app the connect token is scoped to, with a per-requirement `status` for the token's user: `completed` when the user has an active connection or a linked action connector account for the requirement, `pending` otherwise. Served on the management API; authenticate with a connect token.

Start an OAuth2 authorization

Starts an OAuth2 authorization flow for a `connection` requirement whose connection type is OAuth2-based with a configured provider (Google, GitHub, Dropbox, Box, Notion, or Microsoft). Creates a pending end-user connection and returns the provider's authorization URL; redirect the end user there to grant consent. The connection becomes active — and the requirement `completed` — once the provider redirects back and the authorization completes. The request has no body. Served on the management API; authenticate with a connect token.