Docs Workflow
...

Workflow

Este sistema oferece uma solução robusta para automação de fluxos de trabalho, permitindo que os usuários criem e personalizem workflows de maneira intuitiva. Com ele, é possível definir fluxos baseados em eventos específicos, proporcionando flexibilidade na programação de tarefas, seja em intervalos regulares - como a cada 5 minutos - ou em horários predeterminados, como diariamente às 08:00. A grande vantagem deste sistema é a sua capacidade de se integrar facilmente com uma variedade de aplicativos internos disponíveis no marketplace da Iugu, utilizando autenticação segura via JWT, bem como com sistemas externos através de notificações via Webhook.

post https://workflow.iugu.com/services/event

Inicia um fluxo de trabalho a partir de um evento

Autorizações
BearerAuth
HTTP: JWT
HTTP Authorization Scheme: bearer
TokenAuth Autenticação personalizada via token. O token deve ser fornecido no cabeçalho Authorization, precedido pela palavra Bearer. Por exemplo, Authorization Bearer {seu_token}. Para gerar o token, consulte a documentação https://developer.iugu.com/identity/oauth2-client-credentials
Name: Authorization
In: header

Schema Obrigatório

Tipo de conteúdo: application/json

event

Obrigatório

String

Ex: payment_received

payload
Object

Ex: {}

Exemplo
1
2
3
4
5
{
  "event": "payment_received",
  "payload": {
  }
}

Respostas

200
Instância processada com sucesso
success
Array

id
String

message
String

Ex: {"id"=>"c7e8299a-ddd5-4ba0-b788-04a78e7aa122", "message"=>"Instance processed successfully"}

400
Parâmetros ou cabeçalhos obrigatórios estão faltando.
error
String

Ex: The 'event' parameter is required but missing or empty.

401
Não autorizado ou token expirado.
error
String

Ex: Your session has expired. Please log in again.

post https://workflow.iugu.com/api/{workspace_id}/{trigger}

Inicia um fluxo de trabalho a partir de uma trigger

Autorizações
BearerAuth
HTTP: JWT
HTTP Authorization Scheme: bearer
TokenAuth Autenticação personalizada via token. O token deve ser fornecido no cabeçalho Authorization, precedido pela palavra Bearer. Por exemplo, Authorization Bearer {seu_token}. Para gerar o token, consulte a documentação https://developer.iugu.com/identity/oauth2-client-credentials
Name: Authorization
In: header

Schema

Tipo de conteúdo: application/json

payload
Object

Ex: {}

Exemplo
1
2
3
4
{
  "payload": {
  }
}

Parâmetros de Path

  • workspace_id

    Obrigatório

    String

  • trigger

    Obrigatório

    String

Respostas

200
Instância processada com sucesso
success
Array

id
String

message
String

Ex: {"id"=>"c7e8299a-ddd5-4ba0-b788-04a78e7aa122", "message"=>"Instance processed successfully"}

400
Parâmetros ou cabeçalhos obrigatórios estão faltando.
error
String

Ex: The 'event' parameter is required but missing or empty.

401
Não autorizado ou token expirado.
error
String

Ex: Unauthorized. If the issue persists, please contact support with Error ID 1bc0f1c1-65ba-4495-b212-7ebd3b2dbbaa