Skip to main content
POST
/
projects
/
{projectId}
/
webhooks
Create webhook subscription
curl --request POST \
  --url https://devtune.ai/api/v2/projects/{projectId}/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "events": [
    "search-tracking.completed"
  ]
}
'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "url": "<string>",
    "events": [
      "<string>"
    ],
    "isActive": true,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "secret": "<string>"
  },
  "meta": {
    "timestamp": "2023-11-07T05:31:56Z",
    "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

Authorizations

​
Authorization
string
header
required

API key with dtk_live_ prefix. Obtain from Settings > API Keys.

Path Parameters

​
projectId
string<uuid>
required

Body

application/json
​
url
string<uri>
required

URL to POST webhook payloads to

Maximum string length: 2048
​
events
enum<string>[]
required

Event types to subscribe to

Minimum array length: 1
Available options:
search-tracking.completed,
visibility.changed,
actions.generated

Response

Webhook created

​
data
object
​
meta
object