Skip to main content
POST
/
apps
curl -X POST \
  -H "Authorization: Bearer sk_workspace_test_..." \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: 5d42c2c4-f7a3-4c0b-8a6d-2d3c6d38b9c9" \
  -d '{"name":"My App"}' \
  "https://sandbox.api.hopae.com/connect/v1/apps"
{
  "clientId": "HqTRDIYH",
  "clientSecret": "sh_app_...",
  "name": "My App",
  "redirectUris": [],
  "providers": { "passport": { "enabled": true } },
  "defaultWorkflowId": "wf_6ec9b183",
  "workflows": [{ "workflowId": "wf_6ec9b183", "name": "My App", "nodes": [...] }],
  "organizationId": "org_...",
  "webhookConfig": { "enabled": false, "retryAttempts": 3, "timeoutSeconds": 10, "events": [] }
}
Creates an app and returns its credentials.

Request

Authorization
string
required
Bearer <API_KEY> from Console > Developers > Workspace API Keys.
Content-Type
string
application/json
Idempotency-Key
string
Optional UUID to safely retry without creating duplicates.

Request Body

name
string
default:"My App"
required
Display name for the app.

Response

Returns the created App object, including the client secret. Store it securely.
curl -X POST \
  -H "Authorization: Bearer sk_workspace_test_..." \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: 5d42c2c4-f7a3-4c0b-8a6d-2d3c6d38b9c9" \
  -d '{"name":"My App"}' \
  "https://sandbox.api.hopae.com/connect/v1/apps"
{
  "clientId": "HqTRDIYH",
  "clientSecret": "sh_app_...",
  "name": "My App",
  "redirectUris": [],
  "providers": { "passport": { "enabled": true } },
  "defaultWorkflowId": "wf_6ec9b183",
  "workflows": [{ "workflowId": "wf_6ec9b183", "name": "My App", "nodes": [...] }],
  "organizationId": "org_...",
  "webhookConfig": { "enabled": false, "retryAttempts": 3, "timeoutSeconds": 10, "events": [] }
}
Immutable fields: clientId and clientSecret. Update attempts are rejected with a 400 ValidationError.