Skip to main content

Create a target

POST 
https://$CUSTOM-DOMAIN/resources/v3alpha/actions/targets

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

Request​

Query Parameters

    instance.id string
    instance.domain string

Body

required

    name string

    Possible values: non-empty and <= 1000 characters

    restWebhook

    object

    Wait for response but response body is ignored, status is checked, call is sent as post.

    interruptOnError boolean

    Define if any error stops the whole execution. By default the process continues as normal.

    restCall

    object

    Wait for response and response body is used, status is checked, call is sent as post.

    interruptOnError boolean

    Define if any error stops the whole execution. By default the process continues as normal.

    restAsync object

    Call is executed in parallel to others, ZITADEL does not wait until the call is finished. The state is ignored, call is sent as post.

    timeout string

    if the target doesn't respond before this timeout expires, the the connection is closed and the action fails

    endpoint string

    Possible values: non-empty and <= 1000 characters

Responses​

A successful response.

Schema

    details

    object

    id string
    created date-time

    the timestamp of the first event applied to the object.

    changed date-time

    the timestamp of the last event applied to the object.

    owner

    object

    the parent object representing the returned objects context.

    type string

    Possible values: [OWNER_TYPE_UNSPECIFIED, OWNER_TYPE_SYSTEM, OWNER_TYPE_INSTANCE, OWNER_TYPE_ORG]

    Default value: OWNER_TYPE_UNSPECIFIED

    id string
    signingKey string

    Key used to sign and check payload sent to the target.

curl -L 'https://$CUSTOM-DOMAIN/resources/v3alpha/actions/targets' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "name": "ip_allow_list",
  "restWebhook": {
    "interruptOnError": true
  },
  "restCall": {
    "interruptOnError": true
  },
  "restAsync": {},
  "timeout": "10s",
  "endpoint": "https://example.com/hooks/ip_check"
}'
Request Collapse all
Base URL
https://$CUSTOM-DOMAIN
Auth
Parameters
— query
— query
Body required
{
  "name": "ip_allow_list",
  "restWebhook": {
    "interruptOnError": true
  },
  "restCall": {
    "interruptOnError": true
  },
  "restAsync": {},
  "timeout": "10s",
  "endpoint": "https://example.com/hooks/ip_check"
}
ResponseClear

Click the Send API Request button above and see the response here!