OpenAPI Sequence icon

OpenAPI Sequence

Calls an OpenAPI endpoint with raw {} string body for POST

Trigger Rule

AI-generated

Overview

This node, named OpenAPI Sequence, is designed to trigger a specific rule or list accounts by calling an OpenAPI endpoint with a POST request. It is useful for automating interactions with the Sequance API, such as triggering predefined rules remotely or retrieving account information. For example, it can be used to trigger a rule identified by a rule ID or to list accounts associated with an access token.

Use Case Examples

  1. Trigger a rule by providing the rule ID to the node, which sends a POST request to the Sequance API to activate that rule.
  2. List accounts by using the node with the appropriate access token, sending a POST request to retrieve account data.

Properties

Name Meaning
Base URL The server base URL to which the API requests are sent, e.g., https://api.example.com.
Rule ID The identifier of the rule to trigger, formatted as ru_xxx. Used only when the operation is 'Trigger Rule'.

Output

JSON

  • json - The JSON response from the API call, which contains the result of triggering the rule or listing accounts.

Dependencies

  • Requires credentials for API authentication: either a sequence signature API key for triggering rules or a sequence access token for listing accounts.

Troubleshooting

  • Ensure the correct credentials are provided for the selected operation; missing or invalid credentials will cause authentication errors.
  • Verify the Base URL is correct and accessible; incorrect URLs will result in request failures.
  • The Rule ID must be valid and correspond to an existing rule when triggering a rule; otherwise, the API may return an error.

Links

  • Sequance API Documentation - Official API documentation for the Sequance service, useful for understanding endpoints and authentication.

Discussion