Workflows
Submit an idempotent encrypted event into the FinanceGPT workflow runtime
POST
/workflows/events/{key}
Contract
Authentication
Bearer credential required
Required scope
workflow:manage
Status
Published
Parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
key |
path | string | Yes | — |
Idempotency-Key |
header | string | Yes | — |
Request body
application/json
·
optional
{
"template_id": 1,
"payload": []
}
Code examples
These examples compose a request only. Public reference pages never transmit your credential or execute the operation.
curl
curl -X POST \
-H "Authorization: Bearer $FINANCEGPT_API_KEY" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
--data '{
"template_id": 1,
"payload": []
}' \
"https://financegpt.dev/api/v2/workflows/events/{key}"
javascript
const response = await fetch("https:\/\/financegpt.dev\/api\/v2\/workflows\/events\/{key}", {
method: "POST",
headers: {
Authorization: `Bearer ${FINANCEGPT_API_KEY}`,
Accept: 'application/json',
'Content-Type': 'application/json',
},
body: JSON.stringify({
"template_id": 1,
"payload": []
}),
});
const data = await response.json();
python
import json
import os
import requests
response = requests.request(
'POST',
'https://financegpt.dev/api/v2/workflows/events/{key}',
headers={
'Authorization': 'Bearer ' + os.environ['FINANCEGPT_API_KEY'],
'Accept': 'application/json',
},
json=json.loads('{"template_id":1,"payload":[]}'),
)
response.raise_for_status()
print(response.json())
php
<?php
$ch = curl_init('https://financegpt.dev/api/v2/workflows/events/{key}');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer '.getenv('FINANCEGPT_API_KEY'),
'Accept: application/json',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode(array (
'template_id' => 1,
'payload' =>
array (
),
)),
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Responses
| Status | Description |
|---|---|
201 |
Event accepted |
422 |
Missing idempotency key or invalid event payload |
429 |
Workspace workflow execution capacity is temporarily exhausted |
Authority boundary
A developer credential proves application identity and permits only its scopes. It does not grant model promotion, policy override, QLM rebinding, or Financial Actions execution authority unless those separate controls are satisfied.
workflow:manage