Create Target

Creates a new webhook target for the specified project.

POST /v1/targets/{projectId}

Create Target

cURL

curl --request POST \
  --url http://localhost:3004/v1/targets/{projectId} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "url": "<string>",
  "method": "POST",
  "description": "<string>",
  "enabled": true,
  "config": {
    "timeout": 5000,
    "retryCount": 3
  },
  "customHeaders": {}
}
'

Create a new webhook target where events will be delivered.

Authorizations

x-api-key · string · header · required

Path Parameters

projectId · string · required

Body

application/json

name · string · required

Required string length: 3 - 100

url · string<uri> · required

method · enum<string> · default: POST

Available options: POST, PUT, PATCH, GET, DELETE

description · string

Maximum string length: 500

enabled · boolean · default: true

config · object

Show child attributes

customHeaders · object

Show child attributes

Response

201

Target created