Webhooks

Update webhook

Update a webhook’s url, events, or status. Only supplied fields change. url is re-validated (public HTTPS, SSRF-guarded); events must all come from the 25-event catalog (unknown names are rejected); setting status to active also recovers an endpoint auto-paused as failing. Requires scope webhooks:write. Not available under X-Profile-Id delegation - webhooks live on your developer workspace and receive profile events automatically (with profile_id attached).

PUT

webhooks

{id}

Update webhook

curl --request PUT \
  --url https://api.smartlyq.com/v1/webhooks/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "events": [
    "post.published",
    "post.failed",
    "comment.received"
  ],
  "status": "active"
}
'

import requests

url = "https://api.smartlyq.com/v1/webhooks/{id}"

payload = {
    "events": ["post.published", "post.failed", "comment.received"],
    "status": "active"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    events: ['post.published', 'post.failed', 'comment.received'],
    status: 'active'
  })
};

fetch('https://api.smartlyq.com/v1/webhooks/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.smartlyq.com/v1/webhooks/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'events' => [
        'post.published',
        'post.failed',
        'comment.received'
    ],
    'status' => 'active'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.smartlyq.com/v1/webhooks/{id}"

	payload := strings.NewReader("{\n  \"events\": [\n    \"post.published\",\n    \"post.failed\",\n    \"comment.received\"\n  ],\n  \"status\": \"active\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.smartlyq.com/v1/webhooks/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"events\": [\n    \"post.published\",\n    \"post.failed\",\n    \"comment.received\"\n  ],\n  \"status\": \"active\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.smartlyq.com/v1/webhooks/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"events\": [\n    \"post.published\",\n    \"post.failed\",\n    \"comment.received\"\n  ],\n  \"status\": \"active\"\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "id": 128,
    "url": "https://example.com/launch",
    "events": [
      "post.published"
    ],
    "status": "published",
    "last_triggered_at": "2026-07-26T09:41:22Z",
    "created_at": "2026-07-26T09:41:22Z"
  },
  "meta": {
    "request_id": "req_9f3a2b1c-7d4e-4a08-b2c6-5e1f8a9d0c34",
    "timestamp": "2026-07-26T09:41:22Z"
  }
}

{
  "success": false,
  "error": {
    "code": "INVALID_API_KEY",
    "message": "Missing or malformed Authorization header",
    "details": {}
  },
  "meta": {
    "request_id": "req_9f3a2b1c-7d4e-4a08-b2c6-5e1f8a9d0c34",
    "timestamp": "2026-07-26T09:41:22Z"
  }
}

{
  "success": false,
  "error": {
    "code": "RESOURCE_NOT_FOUND",
    "message": "Post not found.",
    "details": {}
  },
  "meta": {
    "request_id": "req_9f3a2b1c-7d4e-4a08-b2c6-5e1f8a9d0c34",
    "timestamp": "2026-07-26T09:41:22Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Missing required fields: content, platforms.",
    "details": {
      "fields": [
        "content",
        "platforms"
      ]
    }
  },
  "meta": {
    "request_id": "req_9f3a2b1c-7d4e-4a08-b2c6-5e1f8a9d0c34",
    "timestamp": "2026-07-26T09:41:22Z"
  }
}

Authorizations

Authorization

string

header

required

API key from Developer dashboard (Bearer token).

Path Parameters

integer

required

Webhook id.

Body

application/json

Provide at least one field.

url

string<uri>

Public HTTPS endpoint.

events

enum<string>[]

Full replacement list of subscribed events.

Available options:

post.published,

post.partial,

post.failed,

account.connected,

account.disconnected,

account.token_expired,

comment.received,

message.received,

job.completed,

job.failed,

balance.low,

balance.depleted,

key.revoked,

wallet.recharge.succeeded,

wallet.recharge.failed,

account_billing.charged,

account_billing.failed,

contact.created,

contact.updated,

contact.tag_added,

contact.tag_removed,

deal.created,

deal.stage_changed,

deal.won,

deal.lost,

post.scheduled,

post.cancelled,

post.recycled,

post.external.created,

post.external.updated,

message.sent,

conversation.started,

reaction.received,

review.new,

review.updated,

message.delivered,

message.read,

message.failed

status

enum<string>

Pause or resume deliveries.

Available options:

active,

paused

Response

Updated webhook

success

enum<boolean>

Available options:

true

data

object

Show child attributes

meta

object

Show child attributes

Send test webhookSynchronously sends a `webhook.test` delivery to the endpoint through the real signing pipeline (same headers and HMAC signature as production events) and returns the outcome. Works even when the endpoint is paused or failing. Test deliveries are never retried by the worker. Requires scope `webhooks:write`. Not available under X-Profile-Id delegation - webhooks live on your developer workspace and receive profile events automatically (with profile_id attached).

Update webhook

curl --request PUT \
  --url https://api.smartlyq.com/v1/webhooks/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "events": [
    "post.published",
    "post.failed",
    "comment.received"
  ],
  "status": "active"
}
'

import requests

url = "https://api.smartlyq.com/v1/webhooks/{id}"

payload = {
    "events": ["post.published", "post.failed", "comment.received"],
    "status": "active"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    events: ['post.published', 'post.failed', 'comment.received'],
    status: 'active'
  })
};

fetch('https://api.smartlyq.com/v1/webhooks/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.smartlyq.com/v1/webhooks/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'events' => [
        'post.published',
        'post.failed',
        'comment.received'
    ],
    'status' => 'active'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.smartlyq.com/v1/webhooks/{id}"

	payload := strings.NewReader("{\n  \"events\": [\n    \"post.published\",\n    \"post.failed\",\n    \"comment.received\"\n  ],\n  \"status\": \"active\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.smartlyq.com/v1/webhooks/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"events\": [\n    \"post.published\",\n    \"post.failed\",\n    \"comment.received\"\n  ],\n  \"status\": \"active\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.smartlyq.com/v1/webhooks/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"events\": [\n    \"post.published\",\n    \"post.failed\",\n    \"comment.received\"\n  ],\n  \"status\": \"active\"\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "id": 128,
    "url": "https://example.com/launch",
    "events": [
      "post.published"
    ],
    "status": "published",
    "last_triggered_at": "2026-07-26T09:41:22Z",
    "created_at": "2026-07-26T09:41:22Z"
  },
  "meta": {
    "request_id": "req_9f3a2b1c-7d4e-4a08-b2c6-5e1f8a9d0c34",
    "timestamp": "2026-07-26T09:41:22Z"
  }
}

{
  "success": false,
  "error": {
    "code": "INVALID_API_KEY",
    "message": "Missing or malformed Authorization header",
    "details": {}
  },
  "meta": {
    "request_id": "req_9f3a2b1c-7d4e-4a08-b2c6-5e1f8a9d0c34",
    "timestamp": "2026-07-26T09:41:22Z"
  }
}

{
  "success": false,
  "error": {
    "code": "RESOURCE_NOT_FOUND",
    "message": "Post not found.",
    "details": {}
  },
  "meta": {
    "request_id": "req_9f3a2b1c-7d4e-4a08-b2c6-5e1f8a9d0c34",
    "timestamp": "2026-07-26T09:41:22Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Missing required fields: content, platforms.",
    "details": {
      "fields": [
        "content",
        "platforms"
      ]
    }
  },
  "meta": {
    "request_id": "req_9f3a2b1c-7d4e-4a08-b2c6-5e1f8a9d0c34",
    "timestamp": "2026-07-26T09:41:22Z"
  }
}

Core

CRM

Profiles

AI Generation

Social

WhatsApp

Inbox

AI Assistants

Update webhook

Authorizations

Path Parameters

Body

Response