Triggers

Get Triggers

get

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Path parameters

project_idstringRequired

Responses

200

Successful Response

application/json

A domain model representing the stored metadata of a Trigger.

Attributes

• project_trigger_id (Mapped[uuid.UUID]): The ID of the instance of this trigger.
• project_id (Mapped[str]): The id of the project that should be executed by this trigger.
• connection_id (Mapped[ConnectionID | None]): The id of the connection that will be used by the trigger (if any).
• provider_id (Mapped[str]): The id of the provider that the trigger belongs to. ie: "stripe"
• trigger_id (Mapped[str]): The id of the Trigger class that will be used to execute this trigger instance. ie: "on_customer_created" for the "stripe" provider in StackAI.
• webhook_data (Mapped[dict[str, Any] | None]): Used to keep track of the data of the webhook in the provider platform when using webhook based triggers. ie: {"form_id": "43dc2afb", "webhook_tag": "stackai-webhook"} in Typeform. Also used to keep track of the cron job id for polling / scheduled triggers.
• cursor_data (Mapped[dict[str, Any] | None]): Used to keep track of the data of the cursor in the provider platform when using polling based triggers. ie: {"last_processed_event_id": "1234567890"} or {"last_processed_event_timestamp": "2025-03-02 10:30:09"} May be None if the trigger is not a polling trigger. (e.g. webhook, scheduled, etc.)
• trigger_config (Mapped[dict[str, Any] | None]): Used to keep track of generic configuration parameters for the trigger. ie: {"inbox_id": "ENTERPRISE_INBOX", "polling_frequency": "10000"}. As opposed to the action nodes, we do not store the trigger config in the nodes themselves, but rather in this column.
• status (Mapped[TriggerStatus]): The status of the trigger: enabled/disabled.
• created_by (Mapped[uuid.UUID]): The user that created the trigger.
• updated_by (Mapped[uuid.UUID]): The user that updated the trigger.
• created_at (Mapped[datetime]): The date and time the trigger was created.
• updated_at (Mapped[datetime]): The date and time the trigger was updated.

project_trigger_idstring · uuidOptional

project_idstringRequired

connection_idany ofOptional

string · uuidOptional

or

nullOptional

provider_idstringRequired

trigger_idstringRequired

webhook_dataany ofOptional

or

nullOptional

cursor_dataany ofOptional

or

nullOptional

trigger_configany ofOptional

or

nullOptional

statusstring · enumOptionalDefault: DISABLEDPossible values:

created_atstring · date-timeOptional

updated_atstring · date-timeOptional

created_bystring · uuidRequired

updated_byany ofOptional

string · uuidOptional

or

nullOptional

422

Validation Error

application/json

get

/projects/{project_id}/triggers

HTTPcURLJavaScriptPython

GET /projects/{project_id}/triggers HTTP/1.1
Host: api.stack-ai.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "project_trigger_id": "123e4567-e89b-12d3-a456-426614174000",
    "project_id": "text",
    "connection_id": "123e4567-e89b-12d3-a456-426614174000",
    "provider_id": "text",
    "trigger_id": "text",
    "webhook_data": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "cursor_data": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "trigger_config": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "status": "DISABLED",
    "created_at": "2026-03-06T22:42:20.413Z",
    "updated_at": "2026-03-06T22:42:20.413Z",
    "created_by": "123e4567-e89b-12d3-a456-426614174000",
    "updated_by": "123e4567-e89b-12d3-a456-426614174000"
  }
]

Create Trigger

post

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Path parameters

project_idstringRequired

Body

application/json

A domain model representing a request to create a new Trigger.

provider_idstringRequired

trigger_idstringRequired

connection_idany ofOptional

string · uuidOptional

or

nullOptional

Responses

201

Successful Response

application/json

422

Validation Error

application/json

post

/projects/{project_id}/triggers

HTTPcURLJavaScriptPython

POST /projects/{project_id}/triggers HTTP/1.1
Host: api.stack-ai.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 160

{
  "provider_id": "text",
  "trigger_id": "text",
  "trigger_config_params": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "connection_id": "123e4567-e89b-12d3-a456-426614174000"
}

{
  "project_trigger_id": "123e4567-e89b-12d3-a456-426614174000",
  "project_id": "text",
  "connection_id": "123e4567-e89b-12d3-a456-426614174000",
  "provider_id": "text",
  "trigger_id": "text",
  "webhook_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "cursor_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "trigger_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "status": "DISABLED",
  "created_at": "2026-03-06T22:42:20.413Z",
  "updated_at": "2026-03-06T22:42:20.413Z",
  "created_by": "123e4567-e89b-12d3-a456-426614174000",
  "updated_by": "123e4567-e89b-12d3-a456-426614174000"
}

Get Trigger

get

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Path parameters

project_trigger_idstring · uuidRequired

Responses

200

Successful Response

application/json

A domain model representing the stored metadata of a Trigger.

Attributes

• project_trigger_id (Mapped[uuid.UUID]): The ID of the instance of this trigger.
• project_id (Mapped[str]): The id of the project that should be executed by this trigger.
• connection_id (Mapped[ConnectionID | None]): The id of the connection that will be used by the trigger (if any).
• provider_id (Mapped[str]): The id of the provider that the trigger belongs to. ie: "stripe"
• trigger_id (Mapped[str]): The id of the Trigger class that will be used to execute this trigger instance. ie: "on_customer_created" for the "stripe" provider in StackAI.
• webhook_data (Mapped[dict[str, Any] | None]): Used to keep track of the data of the webhook in the provider platform when using webhook based triggers. ie: {"form_id": "43dc2afb", "webhook_tag": "stackai-webhook"} in Typeform. Also used to keep track of the cron job id for polling / scheduled triggers.
• cursor_data (Mapped[dict[str, Any] | None]): Used to keep track of the data of the cursor in the provider platform when using polling based triggers. ie: {"last_processed_event_id": "1234567890"} or {"last_processed_event_timestamp": "2025-03-02 10:30:09"} May be None if the trigger is not a polling trigger. (e.g. webhook, scheduled, etc.)
• trigger_config (Mapped[dict[str, Any] | None]): Used to keep track of generic configuration parameters for the trigger. ie: {"inbox_id": "ENTERPRISE_INBOX", "polling_frequency": "10000"}. As opposed to the action nodes, we do not store the trigger config in the nodes themselves, but rather in this column.
• status (Mapped[TriggerStatus]): The status of the trigger: enabled/disabled.
• created_by (Mapped[uuid.UUID]): The user that created the trigger.
• updated_by (Mapped[uuid.UUID]): The user that updated the trigger.
• created_at (Mapped[datetime]): The date and time the trigger was created.
• updated_at (Mapped[datetime]): The date and time the trigger was updated.

project_trigger_idstring · uuidOptional

project_idstringRequired

connection_idany ofOptional

string · uuidOptional

or

nullOptional

provider_idstringRequired

trigger_idstringRequired

webhook_dataany ofOptional

or

nullOptional

cursor_dataany ofOptional

or

nullOptional

trigger_configany ofOptional

or

nullOptional

statusstring · enumOptionalDefault: DISABLEDPossible values:

created_atstring · date-timeOptional

updated_atstring · date-timeOptional

created_bystring · uuidRequired

updated_byany ofOptional

string · uuidOptional

or

nullOptional

422

Validation Error

application/json

get

/triggers/{project_trigger_id}

HTTPcURLJavaScriptPython

GET /triggers/{project_trigger_id} HTTP/1.1
Host: api.stack-ai.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "project_trigger_id": "123e4567-e89b-12d3-a456-426614174000",
  "project_id": "text",
  "connection_id": "123e4567-e89b-12d3-a456-426614174000",
  "provider_id": "text",
  "trigger_id": "text",
  "webhook_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "cursor_data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "trigger_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "status": "DISABLED",
  "created_at": "2026-03-06T22:42:20.413Z",
  "updated_at": "2026-03-06T22:42:20.413Z",
  "created_by": "123e4567-e89b-12d3-a456-426614174000",
  "updated_by": "123e4567-e89b-12d3-a456-426614174000"
}

Delete Trigger

delete

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Path parameters

project_trigger_idstring · uuidRequired

Responses

204

Successful Response

422

Validation Error

application/json

delete

/triggers/{project_trigger_id}

HTTPcURLJavaScriptPython

DELETE /triggers/{project_trigger_id} HTTP/1.1
Host: api.stack-ai.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

Get Triggers By User Org

get

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Responses

200

Successful Response

application/json

A domain model representing a trigger from a user organization.

project_nameany ofRequired

stringOptional

or

nullOptional

get

/triggers

HTTPcURLJavaScriptPython

GET /triggers HTTP/1.1
Host: api.stack-ai.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

200

Successful Response

[
  {
    "project_trigger": {
      "project_trigger_id": "123e4567-e89b-12d3-a456-426614174000",
      "project_id": "text",
      "connection_id": "123e4567-e89b-12d3-a456-426614174000",
      "provider_id": "text",
      "trigger_id": "text",
      "webhook_data": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "cursor_data": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "trigger_config": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "status": "DISABLED",
      "created_at": "2026-03-06T22:42:20.413Z",
      "updated_at": "2026-03-06T22:42:20.413Z",
      "created_by": "123e4567-e89b-12d3-a456-426614174000",
      "updated_by": "123e4567-e89b-12d3-a456-426614174000"
    },
    "project_name": "text"
  }
]

Enable Trigger

post

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Path parameters

project_trigger_idstring · uuidRequired

Responses

200

Successful Response

application/json

anyOptional

422

Validation Error

application/json

post

/triggers/{project_trigger_id}/enable

HTTPcURLJavaScriptPython

POST /triggers/{project_trigger_id}/enable HTTP/1.1
Host: api.stack-ai.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

Disable Trigger

post

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Path parameters

project_trigger_idstring · uuidRequired

Responses

200

Successful Response

application/json

anyOptional

422

Validation Error

application/json

post

/triggers/{project_trigger_id}/disable

HTTPcURLJavaScriptPython

POST /triggers/{project_trigger_id}/disable HTTP/1.1
Host: api.stack-ai.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

Get Available Triggers By Provider

get

Get the list of native triggers available and implemented by Stack AI.

Path parameters

provider_idstringRequired

Responses

200

Successful Response

application/json

trigger_typestring · enumRequiredPossible values:

provider_idstringRequired

The id of the provider

trigger_idstringRequired

The id of the trigger.

trigger_namestringRequired

The name of the trigger.

descriptionstringRequired

instructionsany ofOptional

The instructions of the trigger.

stringOptional

or

nullOptional

iconstringRequired

The icon of the trigger.

tagsany ofOptional

The tags of the trigger

Default: []

string[]Optional

or

nullOptional

versionstringOptional

The version of the trigger

Default: 1.0.0

webhook_requires_verificationbooleanOptional

Whether the webhook requires to be verified by the provider witha challenge request before being created. (e.g. Microsoft Graph Outlook & Slack webhooks requires it)

Default: false

can_get_test_samplesbooleanRead-onlyRequired

Whether the trigger can get test samples.

Returns: bool: True if get_test_samples is not None, False otherwise.

422

Validation Error

application/json

get

/providers/{provider_id}/triggers

HTTPcURLJavaScriptPython

GET /providers/{provider_id}/triggers HTTP/1.1
Host: api.stack-ai.com
Accept: */*

[
  {
    "trigger_type": "POLLING",
    "provider_id": "text",
    "trigger_id": "text",
    "trigger_name": "text",
    "description": "text",
    "instructions": "text",
    "icon": "text",
    "tags": [
      "text"
    ],
    "version": "1.0.0",
    "webhook_requires_verification": false,
    "can_get_test_samples": true
  }
]

Get Specific Trigger From Provider

get

Get the data for a specific native trigger available and implemented by Stack AI.

Path parameters

provider_idstringRequired

trigger_idstringRequired

Responses

200

Successful Response

application/json

trigger_typestring · enumRequiredPossible values:

provider_idstringRequired

The id of the provider

trigger_idstringRequired

The id of the trigger.

trigger_namestringRequired

The name of the trigger.

descriptionstringRequired

instructionsany ofOptional

The instructions of the trigger.

stringOptional

or

nullOptional

iconstringRequired

The icon of the trigger.

tagsany ofOptional

The tags of the trigger

Default: []

string[]Optional

or

nullOptional

versionstringOptional

The version of the trigger

Default: 1.0.0

webhook_requires_verificationbooleanOptional

Whether the webhook requires to be verified by the provider witha challenge request before being created. (e.g. Microsoft Graph Outlook & Slack webhooks requires it)

Default: false

can_get_test_samplesbooleanRead-onlyRequired

Whether the trigger can get test samples.

Returns: bool: True if get_test_samples is not None, False otherwise.

422

Validation Error

application/json

get

/providers/{provider_id}/triggers/{trigger_id}

HTTPcURLJavaScriptPython

GET /providers/{provider_id}/triggers/{trigger_id} HTTP/1.1
Host: api.stack-ai.com
Accept: */*

{
  "trigger_type": "POLLING",
  "provider_id": "text",
  "trigger_id": "text",
  "trigger_name": "text",
  "description": "text",
  "instructions": "text",
  "icon": "text",
  "tags": [
    "text"
  ],
  "version": "1.0.0",
  "webhook_requires_verification": false,
  "can_get_test_samples": true
}

Deprecated

Webhook Trigger

post

Path parameters

project_trigger_idstring · uuidRequired

api_keystringRequired

org_idstringRequired

Query parameters

trigger_idany ofOptional

stringOptional

or

nullOptional

provider_idany ofOptional

stringOptional

or

nullOptional

Responses

202

Successful Response

application/json

422

Validation Error

application/json

post

/organizations/{org_id}/triggers/{project_trigger_id}/webhook/key/{api_key}

HTTPcURLJavaScriptPython

POST /organizations/{org_id}/triggers/{project_trigger_id}/webhook/key/{api_key} HTTP/1.1
Host: api.stack-ai.com
Accept: */*

No content

Deprecated

Polling Trigger

post

Path parameters

project_trigger_idstring · uuidRequired

api_keystringRequired

org_idstringRequired

Responses

202

Successful Response

application/json

422

Validation Error

application/json

post

/organizations/{org_id}/triggers/{project_trigger_id}/polling/key/{api_key}

HTTPcURLJavaScriptPython

POST /organizations/{org_id}/triggers/{project_trigger_id}/polling/key/{api_key} HTTP/1.1
Host: api.stack-ai.com
Accept: */*

No content

Deprecated

Scheduled Trigger

post

Path parameters

project_trigger_idstring · uuidRequired

api_keystringRequired

org_idstringRequired

Responses

202

Successful Response

application/json

422

Validation Error

application/json

post

/organizations/{org_id}/triggers/{project_trigger_id}/scheduled/key/{api_key}

HTTPcURLJavaScriptPython

POST /organizations/{org_id}/triggers/{project_trigger_id}/scheduled/key/{api_key} HTTP/1.1
Host: api.stack-ai.com
Accept: */*

No content

Webhook Handler

post

Handle webhook requests for all incoming webhook events.

Path parameters

webhook_idstringRequired

Webhook identifier - either an app webhook provider (e.g., 'slack', 'github') or a project trigger UUID

Example: slack

Responses

200

Successful Response

application/json

anyOptional

422

Validation Error

application/json

post

/v1/webhooks/{webhook_id}

HTTPcURLJavaScriptPython

POST /v1/webhooks/{webhook_id} HTTP/1.1
Host: api.stack-ai.com
Accept: */*

No content

Get Trigger Test Samples

get

Get test samples for a trigger.

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Path parameters

project_trigger_idstring · uuidRequired

Responses

200

Successful Response

application/json

Other propertiesanyOptional

422

Validation Error

application/json

get

/api/v0/project-triggers/{project_trigger_id}/test-samples

HTTPcURLJavaScriptPython

GET /api/v0/project-triggers/{project_trigger_id}/test-samples HTTP/1.1
Host: api.stack-ai.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}