curl --request POST \
--url 'https://api.hopae.com/connect/v2/apps/{appId}/connections/activations/{activationInstanceId}/instant-activate' \
--header 'Authorization: Bearer sk_workspace_...'
{
"activationInstanceId": "act_01JBX5N8Q2W7RZ3K4M6P9T1V0C",
"status": "activated",
"connectionIds": ["smart-id"],
"connectionInstanceIds": ["conn_01JBX5Q4D8F2H6K9M3N7P1R5T0"]
}
Connections
Instant Activate
Sandbox apps only. Activate a pending submission right away, without waiting for review.
POST
/
connect
/
v2
/
apps
/
{appId}
/
connections
/
activations
/
{activationInstanceId}
/
instant-activate
curl --request POST \
--url 'https://api.hopae.com/connect/v2/apps/{appId}/connections/activations/{activationInstanceId}/instant-activate' \
--header 'Authorization: Bearer sk_workspace_...'
{
"activationInstanceId": "act_01JBX5N8Q2W7RZ3K4M6P9T1V0C",
"status": "activated",
"connectionIds": ["smart-id"],
"connectionInstanceIds": ["conn_01JBX5Q4D8F2H6K9M3N7P1R5T0"]
}
Sandbox apps only. On a production app, this endpoint returns
400 VALIDATION_INVALID_PARAMETER and changes nothing. Hopae reviews and activates production submissions.When to use it
On a sandbox app, Activate Connection activatesdirect and contract connections in its own response. A registration connection comes back with status: "requested". Send that result’s activationInstanceId to this endpoint to finish the activation.
What it does
- Checks that the submission is
requestedorprocessing. Any other status returns409 RESOURCE_CONFLICT, and nothing changes. - Sets the whole submission to
activated. All connections in the submission activate together; you can’t activate only some of them. - Creates a connection instance (
conn_…) for each connection. Sandbox connection instances use Hopae’s managed sandbox credentials. - Enables the new connections in workflows that have Automatically enable newly activated connections turned on, and only in display groups that have no enabled connection yet.
Headers
string
required
Bearer sk_workspace_..., a Workspace API key of the organization that owns the app. See Workspace API.string
A unique key for this request, up to 255 characters. If you retry with the same key within 24 hours, you get the stored response with
Idempotency-Replayed: true. See Request behavior.Path Parameters
string
required
The ID of a sandbox app: an app whose
environment is sandbox in Get App or List Apps.string
required
The submission ID (
act_…): activationInstanceId from Activate Connection, or from instances in List App Connections.Response
200 OK with the activated submission.
string
required
The submission ID.
string
required
Always
activated.string[]
required
The catalog connection IDs the submission covers.
string[]
required
The connection instance IDs (
conn_…) created for the submission. Workflows and Create Verification use these IDs.Errors
Besides the authentication and subscription errors that every route can return (see Workspace API), this endpoint returns:| HTTP | Code | When |
|---|---|---|
| 400 | VALIDATION_INVALID_PARAMETER | The app is a production app. Instant Activate works only on sandbox apps |
| 400 | VALIDATION_INVALID_PARAMETER | Idempotency-Key is longer than 255 characters |
| 403 | AUTH_FORBIDDEN | The app belongs to another organization |
| 404 | RESOURCE_NOT_FOUND | Unknown or deleted app, or the app has no submission with this activationInstanceId |
| 409 | RESOURCE_CONFLICT | The submission is not requested or processing (for example, it is already activated or rejected), or its status changed during the request |
| 409 | IDEMPOTENCY_REQUEST_IN_PROGRESS | An earlier request with the same Idempotency-Key is still running |
curl --request POST \
--url 'https://api.hopae.com/connect/v2/apps/{appId}/connections/activations/{activationInstanceId}/instant-activate' \
--header 'Authorization: Bearer sk_workspace_...'
{
"activationInstanceId": "act_01JBX5N8Q2W7RZ3K4M6P9T1V0C",
"status": "activated",
"connectionIds": ["smart-id"],
"connectionInstanceIds": ["conn_01JBX5Q4D8F2H6K9M3N7P1R5T0"]
}