Webhooks

Create webhook

Creates a webhook and returns its signing secret, which is shown only once.

POSThttps://api.cevoid.com/v2/webhooks

Request

curl -X POST 'https://api.cevoid.com/v2/webhooks' \
  -H "Authorization: Bearer ${CEVOID_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "CRM",
  "url": "https://example.com/webhooks/cevoid",
  "events": [
    "product-review.submitted",
    "post.approved"
  ]
}'

fetch("https://api.cevoid.com/v2/webhooks", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.CEVOID_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    name: "CRM",
    url: "https://example.com/webhooks/cevoid",
    events: [
      "product-review.submitted",
      "post.approved",
    ],
  }),
})
  .then((response) => response.json())
  .then((data) => console.log(data))

const response = await fetch("https://api.cevoid.com/v2/webhooks", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.CEVOID_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    name: "CRM",
    url: "https://example.com/webhooks/cevoid",
    events: [
      "product-review.submitted",
      "post.approved",
    ],
  }),
})
if (!response.ok) throw new Error(`Request failed: ${response.status}`)
const data = await response.json()
console.log(data)

import os

import requests

response = requests.post(
    "https://api.cevoid.com/v2/webhooks",
    headers={
        "Authorization": f"Bearer {os.environ['CEVOID_API_KEY']}",
    },
    json={
        "name": "CRM",
        "url": "https://example.com/webhooks/cevoid",
        "events": [
            "product-review.submitted",
            "post.approved",
        ],
    },
)
response.raise_for_status()
print(response.json())

<?php

$curl = curl_init();
curl_setopt_array($curl, [
  CURLOPT_URL => 'https://api.cevoid.com/v2/webhooks',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_HTTPHEADER => [
    'Authorization: Bearer ' . getenv('CEVOID_API_KEY'),
    'Content-Type: application/json',
  ],
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'CRM',
    'url' => 'https://example.com/webhooks/cevoid',
    'events' => [
      'product-review.submitted',
      'post.approved',
    ],
  ]),
]);

$response = curl_exec($curl);
curl_close($curl);

echo $response;

package main

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

func main() {
	body := strings.NewReader(`{
  "name": "CRM",
  "url": "https://example.com/webhooks/cevoid",
  "events": [
    "product-review.submitted",
    "post.approved"
  ]
}`)
	req, err := http.NewRequest(http.MethodPost, "https://api.cevoid.com/v2/webhooks", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer " + os.Getenv("CEVOID_API_KEY"))
	req.Header.Set("Content-Type", "application/json")

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	data, err := io.ReadAll(res.Body)
	if err != nil {
		panic(err)
	}
	fmt.Println(string(data))
}

Show all 38 linesShow fewer lines

require "json"
require "net/http"

uri = URI("https://api.cevoid.com/v2/webhooks")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer #{ENV.fetch("CEVOID_API_KEY")}"
request["Content-Type"] = "application/json"
request.body = JSON.generate({
  "name" => "CRM",
  "url" => "https://example.com/webhooks/cevoid",
  "events" => [
    "product-review.submitted",
    "post.approved",
  ],
})

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
  http.request(request)
end
puts response.body

Response

{
  "data": {
    "id": "whk_k2m7q4x9b3d5h8n6",
    "name": "CRM",
    "description": null,
    "url": "https://example.com/webhooks/cevoid",
    "status": "ACTIVE",
    "events": [
      "product-review.submitted",
      "post.approved"
    ],
    "created_at": "2026-11-05T09:30:00.000Z",
    "updated_at": "2026-11-05T09:30:00.000Z",
    "signing_secret": "whsec_MfKQ9r8GKYqrTwjUPD8ILPZIo2LaLaSw"
  }
}

{
  "status": 401,
  "code": "unauthorized",
  "message": "Unauthorized",
  "request_id": "req_abc123"
}

{
  "status": 403,
  "code": "forbidden",
  "message": "Forbidden",
  "request_id": "req_abc123"
}

{
  "additional_data": {
    "errors": [
      {
        "field": "query.market",
        "message": "Invalid input: expected string, received array"
      }
    ]
  },
  "status": 404,
  "code": "not_found",
  "message": "Route not found",
  "request_id": "req_abc123"
}

{
  "additional_data": {
    "errors": [
      {
        "field": "query.market",
        "message": "Invalid input: expected string, received array"
      }
    ]
  },
  "status": 422,
  "code": "validation_error",
  "message": "Validation error",
  "request_id": "req_abc123"
}

{
  "status": 429,
  "code": "rate_limit_exceeded",
  "message": "Rate limit exceeded",
  "request_id": "req_abc123",
  "additional_data": {
    "retry_after_seconds": 1
  }
}

{
  "status": 500,
  "code": "internal_server_error",
  "message": "Internal server error",
  "request_id": "req_abc123"
}

Authorizations

Authorizationbearer tokenheaderrequired

Send Authorization: Bearer <key>, where the key is your API key.

Body

application/json

namestringrequired

Display name of the webhook.

Length: 1 to 80
Example: CRM

descriptionstring

Note on what the webhook is for.

Length: 1 to 500
Example: Syncs new reviews to our CRM.

urlstring<uri>required

HTTPS URL that receives the events. It must resolve to a public address.

Maximum length: 2048
Example: https://example.com/webhooks/cevoid

eventsstring[]required

Event types the webhook receives, or ["*"] for every event webhooks can receive, including ones added later.

Minimum items: 1
Each item: length: 1 to 100
Example: ["product-review.submitted","post.approved"]

Response

201 Created successfully application/json

dataobjectrequired

Requested resource.

Properties (9)

idstringrequired

Cevoid webhook ID.

Example: whk_k2m7q4x9b3d5h8n6

namestringrequired

Display name of the webhook.

Example: CRM

descriptionstring | nullrequired

Note on what the webhook is for.

Example: null

urlstringrequired

URL that receives the events.

Example: https://example.com/webhooks/cevoid

statusenum<string>required

Whether the webhook receives events. DISABLED stops every send, including tests and replays.

Allowed values: ACTIVE DISABLED
Example: ACTIVE

eventsstring[]required

Event types the webhook receives, or ["*"] for every event webhooks can receive.

Example: ["product-review.submitted","post.approved"]

created_atstring<date-time>required

Example: 2026-11-05T09:30:00.000Z

updated_atstring<date-time>required

Example: 2026-11-05T09:30:00.000Z

signing_secretstringrequired

Secret that signs every request to the webhook. Store it now; it is not returned again.

Example: whsec_MfKQ9r8GKYqrTwjUPD8ILPZIo2LaLaSw

Response headers (5)

Cevoid-Processing-Msstring

End-to-end request processing time in milliseconds

Cevoid-Request-Idstring

Request identifier for support and tracing

RateLimit-Limitstring

Current rate limit bucket size

RateLimit-Remainingstring

Remaining requests in the current rate limit window

RateLimit-Resetinteger

Seconds until the next request token is available

401 Unauthorized application/json

additional_dataobject

Optional machine-readable error details.

Properties (1)

{key}any

statusnumberrequired

HTTP status code for the error response.

Example: 404

codestringrequired

Stable machine-readable error code.

Example: not_found

messagestringrequired

Human-readable description of the error.

Example: Route not found

request_idstring

Request identifier for support and tracing.

Example: req_abc123

Response headers (5)

Cevoid-Processing-Msstring

End-to-end request processing time in milliseconds

Cevoid-Request-Idstring

Request identifier for support and tracing

RateLimit-Limitstring

Current rate limit bucket size

RateLimit-Remainingstring

Remaining requests in the current rate limit window

RateLimit-Resetinteger

Seconds until the next request token is available

403 Forbidden application/json

additional_dataobject

Optional machine-readable error details.

Properties (1)

{key}any

statusnumberrequired

HTTP status code for the error response.

Example: 404

codestringrequired

Stable machine-readable error code.

Example: not_found

messagestringrequired

Human-readable description of the error.

Example: Route not found

request_idstring

Request identifier for support and tracing.

Example: req_abc123

Response headers (5)

Cevoid-Processing-Msstring

End-to-end request processing time in milliseconds

Cevoid-Request-Idstring

Request identifier for support and tracing

RateLimit-Limitstring

Current rate limit bucket size

RateLimit-Remainingstring

Remaining requests in the current rate limit window

RateLimit-Resetinteger

Seconds until the next request token is available

404 Not found application/json

additional_dataobject

Optional machine-readable error details.

Properties (1)

{key}any

statusnumberrequired

HTTP status code for the error response.

Example: 404

codestringrequired

Stable machine-readable error code.

Example: not_found

messagestringrequired

Human-readable description of the error.

Example: Route not found

request_idstring

Request identifier for support and tracing.

Example: req_abc123

Response headers (5)

Cevoid-Processing-Msstring

End-to-end request processing time in milliseconds

Cevoid-Request-Idstring

Request identifier for support and tracing

RateLimit-Limitstring

Current rate limit bucket size

RateLimit-Remainingstring

Remaining requests in the current rate limit window

RateLimit-Resetinteger

Seconds until the next request token is available

422 Validation error application/json

additional_dataobject

Optional machine-readable error details.

Properties (1)

{key}any

statusnumberrequired

HTTP status code for the error response.

Example: 404

codestringrequired

Stable machine-readable error code.

Example: not_found

messagestringrequired

Human-readable description of the error.

Example: Route not found

request_idstring

Request identifier for support and tracing.

Example: req_abc123

Response headers (5)

Cevoid-Processing-Msstring

End-to-end request processing time in milliseconds

Cevoid-Request-Idstring

Request identifier for support and tracing

RateLimit-Limitstring

Current rate limit bucket size

RateLimit-Remainingstring

Remaining requests in the current rate limit window

RateLimit-Resetinteger

Seconds until the next request token is available

429 Too many requests application/json

additional_dataobjectrequired

Machine-readable rate-limit details.

Properties (2)

retry_after_secondsintegerrequired

Range: 0 <= x

{key}any

statusintegerrequired

HTTP status code.

Example: 404

codestringrequired

Stable machine-readable error code.

Example: not_found

messagestringrequired

Human-readable error description.

Example: Resource not found

request_idstring

Request identifier for support and tracing.

Example: req_abc123

Response headers (6)

Cevoid-Processing-Msstring

End-to-end request processing time in milliseconds

Cevoid-Request-Idstring

Request identifier for support and tracing

RateLimit-Limitstring

Current rate limit bucket size

RateLimit-Remainingstring

Remaining requests in the current rate limit window

RateLimit-Resetinteger

Seconds until the next request token is available

Retry-Afterinteger

Seconds to wait before retrying the request

500 Internal server error application/json

additional_dataobject

Optional machine-readable error details.

Properties (1)

{key}any

statusnumberrequired

HTTP status code for the error response.

Example: 404

codestringrequired

Stable machine-readable error code.

Example: not_found

messagestringrequired

Human-readable description of the error.

Example: Route not found

request_idstring

Request identifier for support and tracing.

Example: req_abc123

Response headers (5)

Cevoid-Processing-Msstring

End-to-end request processing time in milliseconds

Cevoid-Request-Idstring

Request identifier for support and tracing

RateLimit-Limitstring

Current rate limit bucket size

RateLimit-Remainingstring

Remaining requests in the current rate limit window

RateLimit-Resetinteger

Seconds until the next request token is available