List Task Forwarder Types

GET

/org/:org_id/project/:project_id/task_forwarder_type

GET

/api/v1/org/:org_id/project/:project_id/task_forwarder_type

$ curl https://app.rightbrain.ai/api/v1/org/org_id/project/project_id/task_forwarder_type \
>      -H "Authorization: Bearer <token>"

1 [
2   {
3     "type": "webhook",
4     "name": "Webhook",
5     "description": "Forward task results via HTTP POST to a webhook URL",
6     "config_schema": {
7       "properties": {
8         "destination_url": {
9           "description": "The URL where Task Run result will be forwarded. Must be a valid HTTPS URL.",
10           "title": "Destination Url",
11           "type": "string"
12         }
13       },
14       "required": [
15         "destination_url"
16       ],
17       "title": "TaskForwarderConfig",
18       "type": "object"
19     },
20     "config_sensitive_schema": {
21       "properties": {
22         "signing_key": {
23           "description": "A secret key used to sign the forwarded data for verification purposes.",
24           "title": "Signing Key",
25           "type": "string"
26         }
27       },
28       "required": [
29         "signing_key"
30       ],
31       "title": "TaskForwarderSensitiveConfig",
32       "type": "object"
33     }
34   },
35   {
36     "type": "email",
37     "name": "Email",
38     "description": "Send task results via email with customizable templates",
39     "config_schema": {
40       "properties": {
41         "bcc_emails": {
42           "anyOf": [
43             {
44               "items": {
45                 "format": "email",
46                 "type": "string"
47               },
48               "type": "array"
49             },
50             {
51               "type": "null"
52             }
53           ],
54           "description": "Optional list of BCC email addresses.",
55           "title": "Bcc Emails"
56         },
57         "body_template": {
58           "description": "Email body template with {variable} placeholders for task data.",
59           "title": "Body Template",
60           "type": "string"
61         },
62         "cc_emails": {
63           "anyOf": [
64             {
65               "items": {
66                 "format": "email",
67                 "type": "string"
68               },
69               "type": "array"
70             },
71             {
72               "type": "null"
73             }
74           ],
75           "description": "Optional list of CC email addresses.",
76           "title": "Cc Emails"
77         },
78         "recipient_emails": {
79           "description": "List of email addresses to send task results to.",
80           "items": {
81             "format": "email",
82             "type": "string"
83           },
84           "minItems": 1,
85           "title": "Recipient Emails",
86           "type": "array"
87         },
88         "subject_template": {
89           "description": "Email subject template with {variable} placeholders for task data.",
90           "title": "Subject Template",
91           "type": "string"
92         }
93       },
94       "required": [
95         "recipient_emails",
96         "subject_template",
97         "body_template"
98       ],
99       "title": "TaskForwarderEmailConfig",
100       "type": "object"
101     }
102   }
103 ]

List all available task forwarder types with their configuration schemas.

Note: This endpoint returns a plain array of forwarder types, not a paginated response. All available types are returned in a single request.

Returns metadata for each forwarder type to help frontends build dynamic configuration UIs:

webhook: HTTP POST to external endpoints with optional HMAC signing
email: Send task results via email with customizable templates

Each type includes:

JSON Schema for required configuration fields
JSON Schema for sensitive configuration (if applicable)
Field descriptions and validation rules

Use this endpoint to dynamically render appropriate form fields based on the selected forwarder type.

List all available task forwarder types with their configuration schemas. **Note**: This endpoint returns a plain array of forwarder types, not a paginated response. All available types are returned in a single request. Returns metadata for each forwarder type to help frontends build dynamic configuration UIs: - **webhook**: HTTP POST to external endpoints with optional HMAC signing - **email**: Send task results via email with customizable templates Each type includes: - JSON Schema for required configuration fields - JSON Schema for sensitive configuration (if applicable) - Field descriptions and validation rules Use this endpoint to dynamically render appropriate form fields based on the selected forwarder type.

Authentication

AuthorizationBearer

API key or access token, sent as Authorization: Bearer <token>. The simplest option: create an API key in your dashboard under Settings, then paste it here.

AuthorizationBearer

API key or access token, sent as Authorization: Bearer <token>. The simplest option: create an API key in your dashboard under Settings, then paste it here.

Path parameters

org_idstringRequiredformat: "uuid"

The unique identifier of the organization.

project_idstringRequiredformat: "uuid"

The unique identifier of the project.

Response

Available forwarder types with configuration schemas

typestring

The forwarder type identifier (e.g., ‘webhook’, ‘email’)

namestring

Human-readable name for the forwarder type

descriptionstring

Description of what this forwarder type does

config_schemamap from strings to any

JSON Schema for the forwarder's configuration

config_sensitive_schemamap from strings to any or nullOptional

JSON Schema for the forwarder’s sensitive configuration (if any). Will be encrypted within the application.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

422

Unprocessable Entity Error

500

Internal Server Error