Make tools
The 12 Make operations your product runs on your customer's account through Connect. All of them use the same endpoint, POST /api/tools/{tool}/execute.
- List organizationsGETLists the organizations of the user, each with its id and name. The id is the organizationId the other tools ask for.
- List teamsGETLists the teams of an organization, each with its id and name. The id is the teamId of List scenarios.
- List scenariosGETLists the scenarios of a team or of a whole organization: send teamId or organizationId, never both. Each item has the id and name of the scenario.
- Get scenarioGETReturns the details of one scenario, such as its name, team, scheduling and whether it is active.
- Update scenarioPATCHRenames a scenario. The name does not need to be unique.
- Activate scenarioPOSTActivates a scenario so it runs on its schedule. A scenario scheduled at regular intervals also runs right away.
- Deactivate scenarioPOSTDeactivates a scenario, which stops its schedule and the run in progress, if there is one.
- Run scenarioPOSTRuns an active scenario now, which uses operations of the organization. Returns the executionId; with responsive true it waits up to 40 seconds and also returns the status and the scenario outputs. A paused organization or team answers 429 with code IM310.
- List scenario logsGETLists the execution logs of a scenario, newest first, each with the execution id, status, duration, operations and transfer.
- Get scenario executionGETReturns the status of one execution of a scenario, with the scenario outputs, or the error and the module that caused it.
- List incomplete executionsGETLists the incomplete executions of a scenario, the runs that stopped on an error and were stored to be retried, each with id, reason, creation time, attempts and whether it is resolved.
- Retry incomplete executionPOSTRetries an incomplete execution with the blueprint the scenario had when the error happened, which uses operations of the organization.
See Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.
