Task Forwarders

Create a Task Forwarder

GA
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.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

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.
createdstring
When the Task Forwarder was created.
modifiedstring
When the Task Forwarder was last updated.
descriptionstring or null
Additional details about the Task Forwarder's purpose or configuration.
configobject or null

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

config_sensitiveobject or null

Sensitive parameters for the Task Forwarder such as a signing_key.

Errors