PUT
/
webhooks
/
{webhookId}
curl --request PUT \
  --url https://api.us.vartiq.com/webhooks/{webhookId} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "name": "<string>",
  "url": "<string>"
}'
{
  "success": true,
  "message": "<string>",
  "data": {
    "id": "<string>",
    "name": "<string>",
    "url": "<string>",
    "secret": "<string>",
    "customHeaders": [
      {
        "key": "<string>",
        "value": "<string>"
      }
    ],
    "headers": [
      {
        "key": "<string>",
        "value": "<string>"
      }
    ],
    "createdAt": "<string>",
    "updatedAt": "<string>"
  }
}

URL Parameters

webhookId
string
required

The unique identifier of the webhook to update

Body Parameters

name
string

New name for the webhook (2-100 characters)

url
string

New URL where webhook events will be sent

Response

success
boolean

Indicates if the request was successful

message
string

A message describing the result of the operation

data
object

The updated webhook object

Response Example

{
  "success": true,
  "message": "Webhook updated successfully",
  "data": {
    "id": "wh_01JT39T79CFY20Z7G0M2KC4HVC",
    "name": "heelo111",
    "url": "https://exp1.com",
    "secret": "01JT39T79HMJHEYQ9FXZ9VM2XC",
    "customHeaders": [
      {
        "key": "x-app",
        "value": "x-value"
      }
    ],
    "headers": [
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "createdAt": "2025-04-30T12:12:45.756Z",
    "updatedAt": "2025-04-30T12:17:10.831Z"
  }
}
PUT
/
webhooks
/
{webhookId}
curl --request PUT \
  --url https://api.us.vartiq.com/webhooks/{webhookId} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "name": "<string>",
  "url": "<string>"
}'
{
  "success": true,
  "message": "<string>",
  "data": {
    "id": "<string>",
    "name": "<string>",
    "url": "<string>",
    "secret": "<string>",
    "customHeaders": [
      {
        "key": "<string>",
        "value": "<string>"
      }
    ],
    "headers": [
      {
        "key": "<string>",
        "value": "<string>"
      }
    ],
    "createdAt": "<string>",
    "updatedAt": "<string>"
  }
}

URL Parameters

webhookId
string
required

The unique identifier of the webhook to update

Body Parameters

name
string

New name for the webhook (2-100 characters)

url
string

New URL where webhook events will be sent

Response

success
boolean

Indicates if the request was successful

message
string

A message describing the result of the operation

data
object

The updated webhook object

Response Example

{
  "success": true,
  "message": "Webhook updated successfully",
  "data": {
    "id": "wh_01JT39T79CFY20Z7G0M2KC4HVC",
    "name": "heelo111",
    "url": "https://exp1.com",
    "secret": "01JT39T79HMJHEYQ9FXZ9VM2XC",
    "customHeaders": [
      {
        "key": "x-app",
        "value": "x-value"
      }
    ],
    "headers": [
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "createdAt": "2025-04-30T12:12:45.756Z",
    "updatedAt": "2025-04-30T12:17:10.831Z"
  }
}