Get Action by Handle

Retrieve a specific action by its handle in the Rule Engine

🚧

Preview Status

All Rule Engine actions are currently in PREVIEW phase. When creating actions:

  • Monitor action execution results
  • Review scheduled actions regularly
  • Report any issues encountered to our support team

This endpoint allows you to retrieve a specific action by its handle from the Rule Engine. This is useful when you need to check the details and status of a particular scheduled action.

Key Features

  • Retrieve a specific action by its unique handle
  • Get detailed information about action status and configuration
  • Access action execution details and scheduling information

Parameters

Path Parameters

ParameterTypeRequiredDescription
handlestringYesThe unique handle/identifier of the action to retrieve

Response

The response contains detailed information about the requested action:

{
  "id": "action-1234567890",
  "state": "new",
  "created": "2021-09-01T12:00:00Z",
  "details": {
    // Action-specific details based on action type
  },
  "action": "add_addon_to_subscription",
  "schedule": {
    "execution_date": "2023-12-01T10:00:00Z"
  },
  "entity_id": "sub-0001",
  "entity_type": "subscription"
}

Response Fields

FieldTypeDescription
idstringUnique identifier of the action
statestringCurrent state of the action. Possible values: new, success, failure, retrying, nothing_to_do
createdstringTimestamp when the action was created (ISO-8601 format)
detailsobjectAction-specific details that vary based on the action type
actionstringThe type of action (e.g., add_addon_to_subscription, pause_subscription)
scheduleobjectScheduling information containing the execution date
entity_idstringThe ID (handle) of the product on which the action is performed
entity_typestringType of the entity on which the action is performed (e.g., subscription)

Action States

Understanding action states helps you monitor the execution status:

  • new: Action has been created and is waiting for execution
  • success: Action has been executed successfully
  • failure: Action execution failed
  • retrying: Action is being retried after a failure
  • nothing_to_do: Action was processed but no changes were needed

Example Usage

Get a Specific Action

curl -X GET "https://rule-engine-api.frisbii.com/v1/action/action-1234567890" \
  -H "Authorization: Basic <base64-encoded-credentials>"

Related Endpoints

Language
Credentials
Basic
base64
:
Click Try It! to start a request and see the response here!