Create Target

Create a new target to your endpoint, which can be used in executions.

Required permission:

action.target.write

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

restAsync*rest_async

The HTTP call to this target will be a POST request. The call is sent asynchronously and Zitadel does not wait for the response. The response of the target is ignored, no status or body is checked. This is typically used for executions of type "events".

name*name

timeout?timeout

Timeout defines the duration until Zitadel cancels the execution. If the target doesn't respond before this timeout expires, then the connection is closed and the action fails. Depending on the target type and possible setting on interrupt_on_error following targets will not be called. In case of a rest_async target only this specific target will fail, without any influence on other targets of the same execution. The maximum timeout is 270 seconds or 4.5 minutes.

Formatduration

endpoint*endpoint

The URL of the endpoint to call.

payloadType?payload_type

Payload type defines how the payload is formatted and secured. The default is PAYLOAD_TYPE_JSON, which sends the payload as JSON in the body of the request. For integrity and authenticity a signature is included in the header X-ZITADEL-Signature. You can also choose to send the payload as a JWT (PAYLOAD_TYPE_JWT), which sends the payload as a signed JWT in the body of the request. This allows the receiver to verify the authenticity and integrity of the payload using the signing key. If you need encryption as well, you can choose PAYLOAD_TYPE_JWE, which sends the payload as an encrypted JWT in the body of the request. You can provide your own public key for encryption.

Value in"PAYLOAD_TYPE_UNSPECIFIED" | "PAYLOAD_TYPE_JSON" | "PAYLOAD_TYPE_JWT" | "PAYLOAD_TYPE_JWE"

restCall*

The HTTP call to this target will be a POST request. The response of the target will be checked for the status code and the body. In case of an error status code (non 2xx) and interrupt_on_error is set to true, the execution will be aborted and no further targets will be called. In case of a successful status code (2xx) the body will be parsed and mapped. This allows to modify the payload of request and response executions.

name*name

timeout?timeout

Formatduration

endpoint*endpoint

The URL of the endpoint to call.

payloadType?payload_type

Value in"PAYLOAD_TYPE_UNSPECIFIED" | "PAYLOAD_TYPE_JSON" | "PAYLOAD_TYPE_JWT" | "PAYLOAD_TYPE_JWE"

restWebhook*

The HTTP call to this target will be a POST request. The response of the target will only be checked for the status code. The returned body will be ignored. In case of an error status code (non 2xx) and interrupt_on_error is set to true, the execution will be aborted and no further targets will be called.

name*name

timeout?timeout

Formatduration

endpoint*endpoint

The URL of the endpoint to call.

payloadType?payload_type

Value in"PAYLOAD_TYPE_UNSPECIFIED" | "PAYLOAD_TYPE_JSON" | "PAYLOAD_TYPE_JWT" | "PAYLOAD_TYPE_JWE"

Response Body

`application/json`

curl -X POST "https://loading/v2/actions/targets" \  -H "Content-Type: application/json" \  -d '{    "restAsync": {}  }'

{
  "id": "string",
  "creationDate": "2023-01-15T01:30:15.01Z",
  "signingKey": "string"
}

Request Body

Response Body

200application/json

`application/json`