API
- Introduction
- Authentication
- Idempotency
- Versioning
- Silo
- Transform
- Sequences
- Access
- Utils
Create a workflow
Create a new workflow with the given UUID.
curl --request PUT \
--url https://api.invopop.com/transform/v1/workflows/{id} \
--header 'Content-Type: application/json' \
--data '{
"country": "ES",
"description": "<string>",
"name": "<string>",
"schema": "bill/invoice",
"steps": [
{
"action": "email.send",
"config": {},
"id": "186522a6-e697-4e34-8498-eee961bcb845",
"name": "<string>",
"next": [
{
"code": "<string>",
"status": "OK",
"step_id": "186522a6-e697-4e34-8498-eee961bcb845",
"steps": [
{}
],
"stop": true
}
],
"notes": "<string>",
"summary": "<string>"
}
]
}'{
"country": "<string>",
"created_at": "<string>",
"description": "<string>",
"disabled": true,
"draft": true,
"hash": "<string>",
"id": "186522a6-e697-4e34-8498-eee961bcb845",
"name": "<string>",
"rescue": [
{
"action": "email.send",
"config": {},
"id": "186522a6-e697-4e34-8498-eee961bcb845",
"name": "<string>",
"next": [
{
"code": "<string>",
"status": "OK",
"step_id": "186522a6-e697-4e34-8498-eee961bcb845",
"steps": [
{}
],
"stop": true
}
],
"notes": "<string>",
"summary": "<string>"
}
],
"schema": "<string>",
"steps": [
{
"action": "email.send",
"config": {},
"id": "186522a6-e697-4e34-8498-eee961bcb845",
"name": "<string>",
"next": [
{
"code": "<string>",
"status": "OK",
"step_id": "186522a6-e697-4e34-8498-eee961bcb845",
"steps": [
{}
],
"stop": true
}
],
"notes": "<string>",
"summary": "<string>"
}
],
"updated_at": "<string>",
"version": "<string>"
}Path Parameters
UUID (any version) of the workflow to create.
"186522a6-e697-4e34-8498-eee961bcb845"
Body
ISO country code the workflow will be used in.
"ES"
Description of the workflow.
Name of the workflow.
Short schema name that the workflow will be allowed to process.
"bill/invoice"
Array of Steps to use for this workflow.
ID of the action to execute
"email.send"
JSON configuration sent to the provider
The UUID (any version) of the step.
"186522a6-e697-4e34-8498-eee961bcb845"
Name of the step
Optional array of next steps to execute after this one.
Code to match against
Step status to match against, when empty this next step will always be executed.
OK, SKIP, KO, TIMEOUT ID of the step to execute next.
"186522a6-e697-4e34-8498-eee961bcb845"
Array of steps to execute
ID of the action to execute
"email.send"
JSON configuration sent to the provider
The UUID (any version) of the step.
"186522a6-e697-4e34-8498-eee961bcb845"
Name of the step
Optional array of next steps to execute after this one.
Code to match against
Step status to match against, when empty this next step will always be executed.
OK, SKIP, KO, TIMEOUT ID of the step to execute next.
"186522a6-e697-4e34-8498-eee961bcb845"
Array of steps to execute
When true, the workflow will stop.
Additional internal details
Summary of the step's configuration.
When true, the workflow will stop.
Additional internal details
Summary of the step's configuration.
Response
ISO country code the workflow will be used for.
When the workflow was created.
Description of the workflow
When true, this workflow can no longer be used.
When true, this workflow is still in draft mode and will not be used in jobs.
Partial SHA256 hash of the workflow's contents.
The UUID (any version) of the workflow.
"186522a6-e697-4e34-8498-eee961bcb845"
Name of the workflow
List of steps to execute when a KO status is returned by a previous step and not explicitly managed.
ID of the action to execute
"email.send"
JSON configuration sent to the provider
The UUID (any version) of the step.
"186522a6-e697-4e34-8498-eee961bcb845"
Name of the step
Optional array of next steps to execute after this one.
Code to match against
Step status to match against, when empty this next step will always be executed.
OK, SKIP, KO, TIMEOUT ID of the step to execute next.
"186522a6-e697-4e34-8498-eee961bcb845"
Array of steps to execute
ID of the action to execute
"email.send"
JSON configuration sent to the provider
The UUID (any version) of the step.
"186522a6-e697-4e34-8498-eee961bcb845"
Name of the step
Optional array of next steps to execute after this one.
Code to match against
Step status to match against, when empty this next step will always be executed.
OK, SKIP, KO, TIMEOUT ID of the step to execute next.
"186522a6-e697-4e34-8498-eee961bcb845"
Array of steps to execute
When true, the workflow will stop.
Additional internal details
Summary of the step's configuration.
When true, the workflow will stop.
Additional internal details
Summary of the step's configuration.
Short schema name that the workflow will be allowed to process.
List of steps to execute.
ID of the action to execute
"email.send"
JSON configuration sent to the provider
The UUID (any version) of the step.
"186522a6-e697-4e34-8498-eee961bcb845"
Name of the step
Optional array of next steps to execute after this one.
Code to match against
Step status to match against, when empty this next step will always be executed.
OK, SKIP, KO, TIMEOUT ID of the step to execute next.
"186522a6-e697-4e34-8498-eee961bcb845"
Array of steps to execute
ID of the action to execute
"email.send"
JSON configuration sent to the provider
The UUID (any version) of the step.
"186522a6-e697-4e34-8498-eee961bcb845"
Name of the step
Optional array of next steps to execute after this one.
Code to match against
Step status to match against, when empty this next step will always be executed.
OK, SKIP, KO, TIMEOUT ID of the step to execute next.
"186522a6-e697-4e34-8498-eee961bcb845"
Array of steps to execute
When true, the workflow will stop.
Additional internal details
Summary of the step's configuration.
When true, the workflow will stop.
Additional internal details
Summary of the step's configuration.
When the workflow was last updated.
Version of the workflow's contents currently defined.
curl --request PUT \
--url https://api.invopop.com/transform/v1/workflows/{id} \
--header 'Content-Type: application/json' \
--data '{
"country": "ES",
"description": "<string>",
"name": "<string>",
"schema": "bill/invoice",
"steps": [
{
"action": "email.send",
"config": {},
"id": "186522a6-e697-4e34-8498-eee961bcb845",
"name": "<string>",
"next": [
{
"code": "<string>",
"status": "OK",
"step_id": "186522a6-e697-4e34-8498-eee961bcb845",
"steps": [
{}
],
"stop": true
}
],
"notes": "<string>",
"summary": "<string>"
}
]
}'{
"country": "<string>",
"created_at": "<string>",
"description": "<string>",
"disabled": true,
"draft": true,
"hash": "<string>",
"id": "186522a6-e697-4e34-8498-eee961bcb845",
"name": "<string>",
"rescue": [
{
"action": "email.send",
"config": {},
"id": "186522a6-e697-4e34-8498-eee961bcb845",
"name": "<string>",
"next": [
{
"code": "<string>",
"status": "OK",
"step_id": "186522a6-e697-4e34-8498-eee961bcb845",
"steps": [
{}
],
"stop": true
}
],
"notes": "<string>",
"summary": "<string>"
}
],
"schema": "<string>",
"steps": [
{
"action": "email.send",
"config": {},
"id": "186522a6-e697-4e34-8498-eee961bcb845",
"name": "<string>",
"next": [
{
"code": "<string>",
"status": "OK",
"step_id": "186522a6-e697-4e34-8498-eee961bcb845",
"steps": [
{}
],
"stop": true
}
],
"notes": "<string>",
"summary": "<string>"
}
],
"updated_at": "<string>",
"version": "<string>"
}