Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions content/docs/references/data/CustomScriptAction.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: CustomScriptAction
description: CustomScriptAction Schema Reference
---

## Properties

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **name** | `string` | ✅ | Action name |
| **type** | `string` | ✅ | |
| **language** | `Enum<'javascript' \| 'typescript' \| 'python'>` | optional | Script language |
| **code** | `string` | ✅ | Script code to execute |
| **timeout** | `number` | optional | Execution timeout in milliseconds |
| **context** | `Record<string, any>` | optional | Additional context variables |
17 changes: 17 additions & 0 deletions content/docs/references/data/HttpCallAction.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: HttpCallAction
description: HttpCallAction Schema Reference
---

## Properties

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **name** | `string` | ✅ | Action name |
| **type** | `string` | ✅ | |
| **url** | `string` | ✅ | Target URL |
| **method** | `Enum<'GET' \| 'POST' \| 'PUT' \| 'PATCH' \| 'DELETE'>` | ✅ | HTTP method |
| **headers** | `Record<string, string>` | optional | Request headers |
| **body** | `any` | optional | Request body (object/string) |
| **authentication** | `object` | optional | Authentication configuration |
| **timeout** | `number` | optional | Request timeout in milliseconds |
18 changes: 18 additions & 0 deletions content/docs/references/data/PushNotificationAction.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
title: PushNotificationAction
description: PushNotificationAction Schema Reference
---

## Properties

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **name** | `string` | ✅ | Action name |
| **type** | `string` | ✅ | |
| **title** | `string` | ✅ | Notification title |
| **body** | `string` | ✅ | Notification body text |
| **recipients** | `string[]` | ✅ | User IDs or device tokens |
| **data** | `Record<string, any>` | optional | Additional data payload |
| **badge** | `number` | optional | Badge count (iOS) |
| **sound** | `string` | optional | Notification sound |
| **clickAction** | `string` | optional | Action/URL when notification is clicked |
15 changes: 15 additions & 0 deletions content/docs/references/data/SlackMessageAction.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: SlackMessageAction
description: SlackMessageAction Schema Reference
---

## Properties

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **name** | `string` | ✅ | Action name |
| **type** | `string` | ✅ | |
| **channel** | `string` | ✅ | Slack channel ID or name (#channel) |
| **message** | `string` | ✅ | Message text with optional markdown |
| **mentions** | `string[]` | optional | User IDs or @username to mention |
| **threadId** | `string` | optional | Thread ID for replies |
15 changes: 15 additions & 0 deletions content/docs/references/data/SmsNotificationAction.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: SmsNotificationAction
description: SmsNotificationAction Schema Reference
---

## Properties

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **name** | `string` | ✅ | Action name |
| **type** | `string` | ✅ | |
| **provider** | `Enum<'twilio' \| 'vonage'>` | ✅ | SMS provider |
| **recipients** | `string[]` | ✅ | List of phone numbers or user field references |
| **message** | `string` | ✅ | SMS message text or template |
| **fromNumber** | `string` | optional | Sender phone number (provider-specific) |
19 changes: 19 additions & 0 deletions content/docs/references/data/TaskCreationAction.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
title: TaskCreationAction
description: TaskCreationAction Schema Reference
---

## Properties

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **name** | `string` | ✅ | Action name |
| **type** | `string` | ✅ | |
| **taskObject** | `string` | ✅ | Task object name (e.g., "task", "project_task") |
| **subject** | `string` | ✅ | Task subject/title |
| **description** | `string` | optional | Task description |
| **assignedTo** | `string` | optional | User ID or field reference for assignee |
| **dueDate** | `string` | optional | Due date (ISO string or formula) |
| **priority** | `string` | optional | Task priority |
| **relatedTo** | `string` | optional | Related record ID or field reference |
| **additionalFields** | `Record<string, any>` | optional | Additional custom fields |
15 changes: 15 additions & 0 deletions content/docs/references/data/TeamsMessageAction.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: TeamsMessageAction
description: TeamsMessageAction Schema Reference
---

## Properties

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **name** | `string` | ✅ | Action name |
| **type** | `string` | ✅ | |
| **channel** | `string` | ✅ | Teams channel ID |
| **message** | `string` | ✅ | Message text with optional markdown |
| **mentions** | `string[]` | optional | User IDs to mention |
| **teamId** | `string` | optional | Team ID (if not in default team) |
17 changes: 17 additions & 0 deletions content/docs/references/data/WebhookTriggerAction.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: WebhookTriggerAction
description: WebhookTriggerAction Schema Reference
---

## Properties

| Property | Type | Required | Description |
| :--- | :--- | :--- | :--- |
| **name** | `string` | ✅ | Action name |
| **type** | `string` | ✅ | |
| **url** | `string` | ✅ | Webhook URL to call |
| **method** | `Enum<'POST' \| 'PUT'>` | optional | HTTP method |
| **headers** | `Record<string, string>` | optional | Custom headers |
| **payload** | `any` | optional | Webhook payload (uses record data if not specified) |
| **retryOnFailure** | `boolean` | optional | Retry if webhook fails |
| **maxRetries** | `number` | optional | Maximum retry attempts |
2 changes: 1 addition & 1 deletion content/docs/references/data/automation/WorkflowRule.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,5 @@ description: WorkflowRule Schema Reference
| **objectName** | `string` | ✅ | Target Object |
| **triggerType** | `Enum<'on_create' \| 'on_update' \| 'on_create_or_update' \| 'on_delete' \| 'schedule'>` | ✅ | When to evaluate |
| **criteria** | `string` | optional | Formula condition. If TRUE, actions execute. |
| **actions** | `object \| object \| object[]` | optional | Immediate actions |
| **actions** | `object \| object \| object \| object \| object \| object \| object \| object \| object \| object[]` | optional | Immediate actions |
| **active** | `boolean` | optional | Whether this workflow is active |
49 changes: 49 additions & 0 deletions packages/spec/json-schema/CustomScriptAction.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
{
"$ref": "#/definitions/CustomScriptAction",
"definitions": {
"CustomScriptAction": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Action name"
},
"type": {
"type": "string",
"const": "custom_script"
},
"language": {
"type": "string",
"enum": [
"javascript",
"typescript",
"python"
],
"default": "javascript",
"description": "Script language"
},
"code": {
"type": "string",
"description": "Script code to execute"
},
"timeout": {
"type": "number",
"default": 30000,
"description": "Execution timeout in milliseconds"
},
"context": {
"type": "object",
"additionalProperties": {},
"description": "Additional context variables"
}
},
"required": [
"name",
"type",
"code"
],
"additionalProperties": false
}
},
"$schema": "http://json-schema.org/draft-07/schema#"
}
81 changes: 81 additions & 0 deletions packages/spec/json-schema/HttpCallAction.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
{
"$ref": "#/definitions/HttpCallAction",
"definitions": {
"HttpCallAction": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Action name"
},
"type": {
"type": "string",
"const": "http_call"
},
"url": {
"type": "string",
"description": "Target URL"
},
"method": {
"type": "string",
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"description": "HTTP method"
},
"headers": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Request headers"
},
"body": {
"description": "Request body (object/string)"
},
"authentication": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"none",
"basic",
"bearer",
"api_key",
"oauth2"
]
},
"credentials": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"required": [
"type"
],
"additionalProperties": false,
"description": "Authentication configuration"
},
"timeout": {
"type": "number",
"description": "Request timeout in milliseconds"
}
},
"required": [
"name",
"type",
"url",
"method"
],
"additionalProperties": false
}
},
"$schema": "http://json-schema.org/draft-07/schema#"
}
59 changes: 59 additions & 0 deletions packages/spec/json-schema/PushNotificationAction.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
{
"$ref": "#/definitions/PushNotificationAction",
"definitions": {
"PushNotificationAction": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Action name"
},
"type": {
"type": "string",
"const": "push_notification"
},
"title": {
"type": "string",
"description": "Notification title"
},
"body": {
"type": "string",
"description": "Notification body text"
},
"recipients": {
"type": "array",
"items": {
"type": "string"
},
"description": "User IDs or device tokens"
},
"data": {
"type": "object",
"additionalProperties": {},
"description": "Additional data payload"
},
"badge": {
"type": "number",
"description": "Badge count (iOS)"
},
"sound": {
"type": "string",
"description": "Notification sound"
},
"clickAction": {
"type": "string",
"description": "Action/URL when notification is clicked"
}
},
"required": [
"name",
"type",
"title",
"body",
"recipients"
],
"additionalProperties": false
}
},
"$schema": "http://json-schema.org/draft-07/schema#"
}
45 changes: 45 additions & 0 deletions packages/spec/json-schema/SlackMessageAction.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
{
"$ref": "#/definitions/SlackMessageAction",
"definitions": {
"SlackMessageAction": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Action name"
},
"type": {
"type": "string",
"const": "slack_message"
},
"channel": {
"type": "string",
"description": "Slack channel ID or name (#channel)"
},
"message": {
"type": "string",
"description": "Message text with optional markdown"
},
"mentions": {
"type": "array",
"items": {
"type": "string"
},
"description": "User IDs or @username to mention"
},
"threadId": {
"type": "string",
"description": "Thread ID for replies"
}
},
"required": [
"name",
"type",
"channel",
"message"
],
"additionalProperties": false
}
},
"$schema": "http://json-schema.org/draft-07/schema#"
}
Loading
Loading