smartchat

Rotate webhook secret

Creates a new signing secret for an endpoint. During grace_hours (0 to 72, default 24) every delivery carries two signatures, so you can switch without losing events. Returns the new secret, shown only once.

POST /v1/webhook-endpoints/{endpoint_id}/rotate-secret

Permissionwebhooks:write (all permissions)
RiskWrite (no outside effect)
Idempotency-KeyNot needed (how it works)
Safe to repeatNot safe to repeat blindly: the server keeps no key for this call, so a repeat does the work again.
Rate limit classwrite (120 requests per minute per key)
ConfirmationNone
MCP toolNot available in MCP
Since version2026-10-25

#What it does

  • Changes data in your account. It does not send messages to contacts.

#Request

Path parameters

NameTypeDescription
endpoint_idstringWebhook endpoint ID.

Body (JSON)

NameTypeRequiredDescription
grace_hoursintegernoHours during which the old secret still signs. 0 stops the old secret at once. 0 to 72; default 24

#Examples

curl -X POST "https://api.smartchat.marketing/v1/webhook-endpoints/whe_0f8c1a2e4b7d4c3e9a5b6d7e8f901234/rotate-secret" \
  -H "Authorization: Bearer $SMARTCHAT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "grace_hours": 24
}'
import os
import requests

response = requests.post(
    "https://api.smartchat.marketing/v1/webhook-endpoints/whe_0f8c1a2e4b7d4c3e9a5b6d7e8f901234/rotate-secret",
    headers={"Authorization": "Bearer " + os.environ["SMARTCHAT_API_KEY"]},
    json={
        "grace_hours": 24,
    },
)
response.raise_for_status()
print(response.json())
const response = await fetch("https://api.smartchat.marketing/v1/webhook-endpoints/whe_0f8c1a2e4b7d4c3e9a5b6d7e8f901234/rotate-secret", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.SMARTCHAT_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "grace_hours": 24
  }),
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());

Response (200):

{
  "object": "webhook_endpoint",
  "id": "whe_0f8c1a2e4b7d4c3e9a5b6d7e8f901234",
  "url": "https://example.com/hooks/smartchat",
  "description": "Order system",
  "enabled_events": [
    "contact.created",
    "message.received"
  ],
  "status": "active",
  "disabled_reason": null,
  "secret_hint": "whsec_...Lm4Z",
  "consecutive_failures": 0,
  "last_success_at": "2026-10-25T09:45:00Z",
  "last_failure_at": null,
  "secret_previous_expires_at": "2026-10-26T09:50:00Z",
  "created_at": "2026-10-25T09:41:07Z",
  "updated_at": "2026-10-25T09:45:00Z",
  "secret": "whsec_Qe7Rt2YuI9oP0aSdFgHjKlZxCvBnM3wE5rT8yUiO1pA"
}

#Response

Status 200. Every response has the headers Request-Id, SmartChat-Version and X-RateLimit-*.

NameTypeDescription
objectstringAlways "webhook_endpoint". always webhook_endpoint
idstringWebhook endpoint ID.
urlstringHTTPS address that receives the events. up to 2000 characters
descriptionstringYour own note about this endpoint. up to 200 characters
enabled_eventsarray of stringEvent types this endpoint receives, or ["*"] for all available events. up to 30 items
statusstringactive and degraded receive events. paused and disabled do not; call enable_webhook_endpoint. one of: active, degraded, paused, disabled
disabled_reasonstring or nullWhy the endpoint was paused or disabled. Null while it is working. up to 60 characters
secret_hintstringLast 4 characters of the signing secret, for example whsec_...abcd. up to 20 characters
consecutive_failuresintegerFailed delivery attempts in a row since the last success. 0 to 1000000
last_success_atstring or nullTime of the last successful delivery. up to 40 characters; format date-time
last_failure_atstring or nullTime of the last failed delivery attempt. up to 40 characters; format date-time
secret_previous_expires_atstring or nullWhile a secret rotation is running: when the old secret stops signing. Otherwise null. up to 40 characters; format date-time
created_atstringWhen the endpoint was created. up to 40 characters; format date-time
updated_atstringWhen the endpoint was last changed. up to 40 characters; format date-time
secretstringSigning secret (whsec_...). Store it now; it is never shown again. up to 80 characters

#Errors

CodeStatusWhen
api_key_expired401This API key has expired.
api_key_invalid401This API key is not valid.
api_key_revoked401This API key was revoked.
authentication_required401No API key was sent. Send 'Authorization: Bearer <key>'.
insufficient_scope403This key lacks a required permission.
ip_not_allowed403This IP address is not allowed for this key.
endpoint_not_found404No webhook endpoint with this ID exists in this account.
validation_failed422A field is not valid.
rate_limited429Too many requests. Wait and try again.
internal_error500Something went wrong on our side.

All errors use one format.