The Log API allows you to retrieve and filter logs for flows and steps. This is useful for setting up monitoring and alerts (e.g., sending Slack notifications when errors occur).

Endpoints

1. Filter by Flow and Step

GET <https://api.platform.openintegrationhub.com/logs?filter[flowId]={flowId}&filter[stepId]={stepId}>

2. Filter by Tenant

GET <https://api.platform.openintegrationhub.com/logs?filter[tenant]={tenantId}>

3. Show Only Errors

GET <https://api.platform.openintegrationhub.com/logs?filter[flowId]={flowId}&showErrors=true>

Query Parameters

Parameter

Parameter Description
filter[flowId] ID of the flow to fetch logs for.
filter[stepId] ID of the step to fetch logs for.
showErrors Set to true to filter logs containing "Error".

Example Use Cases

  1. Monitor a specific flow step for errors

    GET /logs?filter[flowId]=123&filter[stepId]=abc&showErrors=true
    
  2. Get all tenant logs, only errors

    GET /logs?filter[tenant]=456&showErrors=true