Create a Task Forwarder — Rightbrain

A Task Forwarder will receive the output of a Task and forward it to the specified destination. This can be used to send data to external systems, or to trigger other actions based on the output of a Task.

Path parameters

org_idstringRequired

The unique identifier of the organization.

project_idstringRequired

The unique identifier of the project.

Request

This endpoint expects an object.

namestringRequired

A descriptive name for the Task Forwarder.

descriptionstringOptional

Additional details about the Task Forwarder’s purpose or configuration.

configobjectOptional

Configuration parameters for the Task Forwarder such as a destination URL.

config_sensitiveobjectOptional

Sensitive parameters for the Task Forwarder such as a signing_key.

Response

Successfully created task forwarder

namestring

A descriptive name for the Task Forwarder.

idstringformat: "uuid"

The unique identifier of the Task Forwarder.

project_idstringformat: "uuid"

The Project that the Task Forwarder belongs to.

createddatetime

When the Task Forwarder was created.

modifieddatetime

When the Task Forwarder was last updated.

descriptionstringOptional

Additional details about the Task Forwarder’s purpose or configuration.

configobjectOptional

Configuration parameters for the Task Forwarder such as a destination URL.

config_sensitiveobjectOptional

Sensitive parameters for the Task Forwarder such as a signing_key.

Errors

1 curl -X POST https://app.rightbrain.ai/api/v1/org/123e4567-e89b-12d3-a456-426614174000/project/123e4567-e89b-12d3-a456-426614174001/task_forwarder \ 2 -H "Authorization: Bearer <token>" \ 3 -H "Content-Type: application/json" \ 4 -d '{ 5 "name": "Webhook Endpoint", 6 "description": "Send all Task output to this API endpoint to ensure real-time updates of all Task Runs.", 7 "config": { 8 "destination_url": "https://eoalydnvgieppd9.m.pipedream.net" 9 }, 10 "config_sensitive": { 11 "signing_key": "sdkjhsfd2sdfkj3223.23rh" 12 } 13 }'

1 { 2 "name": "Slack Notification", 3 "id": "0190a234-8dc6-6d08-aea9-928fcecad8f1", 4 "project_id": "0190a234-8dc6-6d08-aea9-928fcecad8f2", 5 "created": "2024-01-16T13:33:25Z", 6 "modified": "2024-01-16T13:33:25Z", 7 "description": "description", 8 "config": { 9 "destination_url": "destination_url" 10 }, 11 "config_sensitive": { 12 "signing_key": "signing_key" 13 } 14 }

1	curl -X POST https://app.rightbrain.ai/api/v1/org/123e4567-e89b-12d3-a456-426614174000/project/123e4567-e89b-12d3-a456-426614174001/task_forwarder \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"name": "Webhook Endpoint",
6	"description": "Send all Task output to this API endpoint to ensure real-time updates of all Task Runs.",
7	"config": {
8	"destination_url": "https://eoalydnvgieppd9.m.pipedream.net"
9	},
10	"config_sensitive": {
11	"signing_key": "sdkjhsfd2sdfkj3223.23rh"
12	}
13	}'

1	{
2	"name": "Slack Notification",
3	"id": "0190a234-8dc6-6d08-aea9-928fcecad8f1",
4	"project_id": "0190a234-8dc6-6d08-aea9-928fcecad8f2",
5	"created": "2024-01-16T13:33:25Z",
6	"modified": "2024-01-16T13:33:25Z",
7	"description": "description",
8	"config": {
9	"destination_url": "destination_url"
10	},
11	"config_sensitive": {
12	"signing_key": "signing_key"
13	}
14	}