Endpoint URL:
https://aisenseapi.com/services/v1/webhook_action

Description:
This API provides a simple way to create interactive actions that require a human response through a generated web form. It is designed for workflows where an automated system needs confirmation, approval, or additional input from a user before continuing a process.

The API works by creating an action session. When a session is created, the system generates a unique action ID and two URLs.

form_url
Used to present a web form where a user can submit a response.

result_url
Used to retrieve the status of the action and the submitted response.

The form structure is defined when the action session is created. The API supports multiple field types including radio buttons, select menus, text inputs, textareas, and checkboxes.

Once a user submits the form, the action status changes to answered and the submitted data becomes available through the result URL.

All action sessions are stored temporarily and automatically expire after 24 hours.

Response Format:

Content-Type: application/json

Create Action Session

Request:
POST https://aisenseapi.com/services/v1/webhook_action

Request Body Example: json

{
 "title": "Approval required",
 "description": "Please review and approve this request.",
 "fields": [
  {
   "type": "radio",
   "name": "decision",
   "label": "Select decision",
   "required": true,
   "options": [
    { "value": "approve", "label": "Approve" },
    { "value": "reject", "label": "Reject" }
   ]
  },
  {
   "type": "textarea",
   "name": "comment",
   "label": "Comment",
   "placeholder": "Optional comment",
   "max_length": 500
  }
 ]
}

Example Success Response: json

{
 "ok": true,
 "action_id": "9e0e6d3b-1a45-44c5-9e0b-92f5f3bdb2f1",
 "form_url": "https://aisenseapi.com/services/v1/webhook_action/9e0e6d3b-1a45-44c5-9e0b-92f5f3bdb2f1/form",
 "result_url": "https://aisenseapi.com/services/v1/webhook_action/9e0e6d3b-1a45-44c5-9e0b-92f5f3bdb2f1",
 "expire_timestamp": 1772893200,
 "expire_datetime": "2026-03-07T14:20:00Z"
}

Opening the Form

The returned form_url provides a user friendly HTML form where the action can be completed.

Example:

https://aisenseapi.com/services/v1/webhook_action/{action_id}/form

The form dynamically renders all configured fields and validates required inputs before submission.

After submission, the response is stored and the action status changes to answered.

Retrieving the Action Result

To retrieve the current action status and the submitted response, send a GET request to the result URL.

Example

GET https://aisenseapi.com/services/v1/webhook_action/{action_id}

Example Response Before Submission: json

{
 "ok": true,
 "action_id": "9e0e6d3b-1a45-44c5-9e0b-92f5f3bdb2f1",
 "status": "pending",
 "created_at_timestamp": 1772806800,
 "created_at_datetime": "2026-03-06T14:20:00Z",
 "expire_timestamp": 1772893200,
 "expire_datetime": "2026-03-07T14:20:00Z",
 "answered_at_timestamp": null,
 "answered_at_datetime": null,
 "response": null
}

Example Response After Submission: json

{
 "ok": true,
 "action_id": "9e0e6d3b-1a45-44c5-9e0b-92f5f3bdb2f1",
 "status": "answered",
 "created_at_timestamp": 1772806800,
 "created_at_datetime": "2026-03-06T14:20:00Z",
 "expire_timestamp": 1772893200,
 "expire_datetime": "2026-03-07T14:20:00Z",
 "answered_at_timestamp": 1772810000,
 "answered_at_datetime": "2026-03-06T15:13:20Z",
 "response": {
  "decision": "approve",
  "comment": "Looks good"
 }
}

Supported Field Types

radio
Displays multiple options where only one can be selected.

select
Dropdown menu containing predefined options.

text
Single line text input.

textarea
Multi line text input.

checkbox
Boolean option returning either 1 or 0.

Example Error Response: json

{ “error”: “Action id unknown” }

Use Cases

Human approval workflows for automated systems.

Confirming actions triggered by external APIs.

Collecting structured user input during automated processes.

Approval steps in CI pipelines, payment flows, or deployment processes.

Capturing user responses for AI agents or automation pipelines.

Typical Workflow

Create an action session using the endpoint above.

Send the returned form_url to a user via email, chat, Slack, or another system.

The user opens the form and submits their response.

Retrieve the result using the result_url.

Continue your automation workflow based on the submitted response.

All stored action sessions automatically expire after 24 hours.