Cambiar el secreto de una URL de avisos

curl --request POST \
  --url https://api.craqui.com/v1/webhook_endpoints/{id}/rotate_secret \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "expire_previous_in_hours": 24
}
'

import requests

url = "https://api.craqui.com/v1/webhook_endpoints/{id}/rotate_secret"

payload = { "expire_previous_in_hours": 24 }
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({expire_previous_in_hours: 24})
};

fetch('https://api.craqui.com/v1/webhook_endpoints/{id}/rotate_secret', 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.craqui.com/v1/webhook_endpoints/{id}/rotate_secret",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'expire_previous_in_hours' => 24
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-key>"
  ],
]);

$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.craqui.com/v1/webhook_endpoints/{id}/rotate_secret"

	payload := strings.NewReader("{\n  \"expire_previous_in_hours\": 24\n}")

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

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	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.post("https://api.craqui.com/v1/webhook_endpoints/{id}/rotate_secret")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"expire_previous_in_hours\": 24\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.craqui.com/v1/webhook_endpoints/{id}/rotate_secret")

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

request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"expire_previous_in_hours\": 24\n}"

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

{
  "id": "whe_2d3gn7x2sz9rgsmv8z1hdqx6h1",
  "object": "webhook_endpoint",
  "livemode": true,
  "url": "https://hooks.recepcion-marea.example.com/craqui",
  "description": "CRM de recepción",
  "enabled_events": [
    "booking.created",
    "booking.cancelled",
    "booking.attended"
  ],
  "status": "enabled",
  "disabled_reason": null,
  "api_version": "2026-12-01",
  "created_at": "2026-11-20T15:30:00-03:00",
  "updated_at": "2026-12-01T10:00:00-03:00",
  "secret": "whsec_TnVldm9TZWNyZXRv/RGVNYXJlYQ+RWplbXBsbzQ1Ng=="
}

{
  "type": "https://docs.craqui.com/errors/invalid_api_key",
  "title": "La clave no es válida",
  "status": 401,
  "code": "invalid_api_key",
  "request_id": "req_01hzx8m4k2a7d9q3f5w6y8z0bc",
  "detail": "Revisa que copiaste la clave completa, incluido el prefijo (crq_live_ o crq_test_).",
  "doc_url": "<string>",
  "required_scope": "business:read",
  "errors": [
    {
      "field": "session_id",
      "code": "invalid_prefix",
      "detail": "<string>"
    }
  ]
}

{
  "type": "https://docs.craqui.com/errors/revoked_api_key",
  "title": "La clave fue revocada",
  "status": 401,
  "code": "revoked_api_key",
  "detail": "Crea una clave nueva en Configuración → Integraciones.",
  "request_id": "req_01hzx8m4k2a7d9q3f5w6y8z0bc"
}

{
  "type": "https://docs.craqui.com/errors/invalid_api_key",
  "title": "La clave no es válida",
  "status": 401,
  "code": "invalid_api_key",
  "request_id": "req_01hzx8m4k2a7d9q3f5w6y8z0bc",
  "detail": "Revisa que copiaste la clave completa, incluido el prefijo (crq_live_ o crq_test_).",
  "doc_url": "<string>",
  "required_scope": "business:read",
  "errors": [
    {
      "field": "session_id",
      "code": "invalid_prefix",
      "detail": "<string>"
    }
  ]
}

{
  "type": "https://docs.craqui.com/errors/invalid_api_key",
  "title": "La clave no es válida",
  "status": 401,
  "code": "invalid_api_key",
  "request_id": "req_01hzx8m4k2a7d9q3f5w6y8z0bc",
  "detail": "Revisa que copiaste la clave completa, incluido el prefijo (crq_live_ o crq_test_).",
  "doc_url": "<string>",
  "required_scope": "business:read",
  "errors": [
    {
      "field": "session_id",
      "code": "invalid_prefix",
      "detail": "<string>"
    }
  ]
}

{
  "type": "https://docs.craqui.com/errors/sandbox_unavailable",
  "title": "Tu estudio de prueba no está listo",
  "status": 409,
  "code": "sandbox_unavailable",
  "detail": "Restablece tus datos de prueba en Configuración → Integraciones y vuelve a intentar.",
  "request_id": "req_01hzx8m4k2a7d9q3f5w6y8z0bc"
}

{
  "type": "https://docs.craqui.com/errors/invalid_api_key",
  "title": "La clave no es válida",
  "status": 401,
  "code": "invalid_api_key",
  "request_id": "req_01hzx8m4k2a7d9q3f5w6y8z0bc",
  "detail": "Revisa que copiaste la clave completa, incluido el prefijo (crq_live_ o crq_test_).",
  "doc_url": "<string>",
  "required_scope": "business:read",
  "errors": [
    {
      "field": "session_id",
      "code": "invalid_prefix",
      "detail": "<string>"
    }
  ]
}

{
  "type": "https://docs.craqui.com/errors/invalid_api_key",
  "title": "La clave no es válida",
  "status": 401,
  "code": "invalid_api_key",
  "request_id": "req_01hzx8m4k2a7d9q3f5w6y8z0bc",
  "detail": "Revisa que copiaste la clave completa, incluido el prefijo (crq_live_ o crq_test_).",
  "doc_url": "<string>",
  "required_scope": "business:read",
  "errors": [
    {
      "field": "session_id",
      "code": "invalid_prefix",
      "detail": "<string>"
    }
  ]
}

{
  "type": "https://docs.craqui.com/errors/invalid_api_key",
  "title": "La clave no es válida",
  "status": 401,
  "code": "invalid_api_key",
  "request_id": "req_01hzx8m4k2a7d9q3f5w6y8z0bc",
  "detail": "Revisa que copiaste la clave completa, incluido el prefijo (crq_live_ o crq_test_).",
  "doc_url": "<string>",
  "required_scope": "business:read",
  "errors": [
    {
      "field": "session_id",
      "code": "invalid_prefix",
      "detail": "<string>"
    }
  ]
}

{
  "type": "https://docs.craqui.com/errors/invalid_api_key",
  "title": "La clave no es válida",
  "status": 401,
  "code": "invalid_api_key",
  "request_id": "req_01hzx8m4k2a7d9q3f5w6y8z0bc",
  "detail": "Revisa que copiaste la clave completa, incluido el prefijo (crq_live_ o crq_test_).",
  "doc_url": "<string>",
  "required_scope": "business:read",
  "errors": [
    {
      "field": "session_id",
      "code": "invalid_prefix",
      "detail": "<string>"
    }
  ]
}

webhook_endpoints

Cambiar el secreto de una URL de avisos

Craqui empieza a firmar con un secreto nuevo, que viene en la respuesta (es la única vez). Durante expire_previous_in_hours (de 0 a 168, 24 si no lo mandas) firma con los dos, el nuevo primero, para que actualices tu sistema sin perder avisos. Si repites el pedido con la misma Idempotency-Key, la respuesta guardada trae secret: null.

Solo para estudios: en una academia responde wrong_vertical. Solo con una clave crq_live_: una crq_test_ responde scope_required (tu estudio de prueba no envía avisos).

POST

webhook_endpoints

{id}

rotate_secret

Cambiar el secreto de una URL de avisos

curl --request POST \
  --url https://api.craqui.com/v1/webhook_endpoints/{id}/rotate_secret \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "expire_previous_in_hours": 24
}
'

import requests

url = "https://api.craqui.com/v1/webhook_endpoints/{id}/rotate_secret"

payload = { "expire_previous_in_hours": 24 }
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({expire_previous_in_hours: 24})
};

fetch('https://api.craqui.com/v1/webhook_endpoints/{id}/rotate_secret', 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.craqui.com/v1/webhook_endpoints/{id}/rotate_secret",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'expire_previous_in_hours' => 24
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-key>"
  ],
]);

$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.craqui.com/v1/webhook_endpoints/{id}/rotate_secret"

	payload := strings.NewReader("{\n  \"expire_previous_in_hours\": 24\n}")

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

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	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.post("https://api.craqui.com/v1/webhook_endpoints/{id}/rotate_secret")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"expire_previous_in_hours\": 24\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.craqui.com/v1/webhook_endpoints/{id}/rotate_secret")

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

request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"expire_previous_in_hours\": 24\n}"

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

{
  "id": "whe_2d3gn7x2sz9rgsmv8z1hdqx6h1",
  "object": "webhook_endpoint",
  "livemode": true,
  "url": "https://hooks.recepcion-marea.example.com/craqui",
  "description": "CRM de recepción",
  "enabled_events": [
    "booking.created",
    "booking.cancelled",
    "booking.attended"
  ],
  "status": "enabled",
  "disabled_reason": null,
  "api_version": "2026-12-01",
  "created_at": "2026-11-20T15:30:00-03:00",
  "updated_at": "2026-12-01T10:00:00-03:00",
  "secret": "whsec_TnVldm9TZWNyZXRv/RGVNYXJlYQ+RWplbXBsbzQ1Ng=="
}

{
  "type": "https://docs.craqui.com/errors/invalid_api_key",
  "title": "La clave no es válida",
  "status": 401,
  "code": "invalid_api_key",
  "request_id": "req_01hzx8m4k2a7d9q3f5w6y8z0bc",
  "detail": "Revisa que copiaste la clave completa, incluido el prefijo (crq_live_ o crq_test_).",
  "doc_url": "<string>",
  "required_scope": "business:read",
  "errors": [
    {
      "field": "session_id",
      "code": "invalid_prefix",
      "detail": "<string>"
    }
  ]
}

{
  "type": "https://docs.craqui.com/errors/revoked_api_key",
  "title": "La clave fue revocada",
  "status": 401,
  "code": "revoked_api_key",
  "detail": "Crea una clave nueva en Configuración → Integraciones.",
  "request_id": "req_01hzx8m4k2a7d9q3f5w6y8z0bc"
}

{
  "type": "https://docs.craqui.com/errors/invalid_api_key",
  "title": "La clave no es válida",
  "status": 401,
  "code": "invalid_api_key",
  "request_id": "req_01hzx8m4k2a7d9q3f5w6y8z0bc",
  "detail": "Revisa que copiaste la clave completa, incluido el prefijo (crq_live_ o crq_test_).",
  "doc_url": "<string>",
  "required_scope": "business:read",
  "errors": [
    {
      "field": "session_id",
      "code": "invalid_prefix",
      "detail": "<string>"
    }
  ]
}

{
  "type": "https://docs.craqui.com/errors/invalid_api_key",
  "title": "La clave no es válida",
  "status": 401,
  "code": "invalid_api_key",
  "request_id": "req_01hzx8m4k2a7d9q3f5w6y8z0bc",
  "detail": "Revisa que copiaste la clave completa, incluido el prefijo (crq_live_ o crq_test_).",
  "doc_url": "<string>",
  "required_scope": "business:read",
  "errors": [
    {
      "field": "session_id",
      "code": "invalid_prefix",
      "detail": "<string>"
    }
  ]
}

{
  "type": "https://docs.craqui.com/errors/sandbox_unavailable",
  "title": "Tu estudio de prueba no está listo",
  "status": 409,
  "code": "sandbox_unavailable",
  "detail": "Restablece tus datos de prueba en Configuración → Integraciones y vuelve a intentar.",
  "request_id": "req_01hzx8m4k2a7d9q3f5w6y8z0bc"
}

{
  "type": "https://docs.craqui.com/errors/invalid_api_key",
  "title": "La clave no es válida",
  "status": 401,
  "code": "invalid_api_key",
  "request_id": "req_01hzx8m4k2a7d9q3f5w6y8z0bc",
  "detail": "Revisa que copiaste la clave completa, incluido el prefijo (crq_live_ o crq_test_).",
  "doc_url": "<string>",
  "required_scope": "business:read",
  "errors": [
    {
      "field": "session_id",
      "code": "invalid_prefix",
      "detail": "<string>"
    }
  ]
}

{
  "type": "https://docs.craqui.com/errors/invalid_api_key",
  "title": "La clave no es válida",
  "status": 401,
  "code": "invalid_api_key",
  "request_id": "req_01hzx8m4k2a7d9q3f5w6y8z0bc",
  "detail": "Revisa que copiaste la clave completa, incluido el prefijo (crq_live_ o crq_test_).",
  "doc_url": "<string>",
  "required_scope": "business:read",
  "errors": [
    {
      "field": "session_id",
      "code": "invalid_prefix",
      "detail": "<string>"
    }
  ]
}

{
  "type": "https://docs.craqui.com/errors/invalid_api_key",
  "title": "La clave no es válida",
  "status": 401,
  "code": "invalid_api_key",
  "request_id": "req_01hzx8m4k2a7d9q3f5w6y8z0bc",
  "detail": "Revisa que copiaste la clave completa, incluido el prefijo (crq_live_ o crq_test_).",
  "doc_url": "<string>",
  "required_scope": "business:read",
  "errors": [
    {
      "field": "session_id",
      "code": "invalid_prefix",
      "detail": "<string>"
    }
  ]
}

{
  "type": "https://docs.craqui.com/errors/invalid_api_key",
  "title": "La clave no es válida",
  "status": 401,
  "code": "invalid_api_key",
  "request_id": "req_01hzx8m4k2a7d9q3f5w6y8z0bc",
  "detail": "Revisa que copiaste la clave completa, incluido el prefijo (crq_live_ o crq_test_).",
  "doc_url": "<string>",
  "required_scope": "business:read",
  "errors": [
    {
      "field": "session_id",
      "code": "invalid_prefix",
      "detail": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

Clave del negocio. sk es una clave completa (todo lo que el rol de quien la creó puede dar) y rk una restringida a los permisos que se eligieron al crearla. Solo se usa desde un servidor: un pedido desde un navegador se rechaza con browser_not_allowed.

Headers

Craqui-Version

string

Versión de la API para este pedido (YYYY-MM-DD). Si no la mandas, se usa la versión fijada en la clave cuando se creó.

Pattern: ^\d{4}-\d{2}-\d{2}$

Example:

"2026-12-01"

Idempotency-Key

string

required

Obligatorio en todo POST que crea o modifica algo. Un valor único por operación (por ejemplo un UUID). Si repites el pedido con la misma clave y el mismo cuerpo dentro de 24 horas, recibes la misma respuesta sin que se repita el efecto.

Required string length: 1 - 255

Path Parameters

string

required

El id de la URL (whe_…). Id de una URL de avisos.

Pattern: ^whe_[0-7][0-9a-hjkmnp-tv-z]{25}$

Example:

"whe_2d3gn7x2sz9rgsmv8z1hdqx6h1"

Body

application/json

expire_previous_in_hours

integer

default:24

Horas en que el secreto anterior sigue firmando junto al nuevo (el nuevo primero). 0 lo retira ya.

Required range: 0 <= x <= 168

Response

OK.

Una URL a la que Craqui le avisa cada vez que algo cambia en tu estudio. Cada aviso es un event firmado con Standard Webhooks (headers webhook-id, webhook-timestamp y webhook-signature). Si tu sistema no responde 2xx, se reintenta durante unos 3 días; si falla de forma sostenida, la URL se desactiva (disabled_reason: failing) y se le avisa al propietario del estudio.

Tu clave solo ve las URLs creadas por la API cuyos avisos puede leer: las que creó el propietario desde el panel no aparecen.

string

required

Id de una URL de avisos.

Pattern: ^whe_[0-7][0-9a-hjkmnp-tv-z]{25}$

Example:

"whe_2d3gn7x2sz9rgsmv8z1hdqx6h1"

object

string

required

Allowed value: "webhook_endpoint"

livemode

boolean

required

true: solo una clave crq_live_ configura avisos (una crq_test_ no; tu estudio de prueba no envía nada).

url

string<uri>

required

La URL, https:// en el puerto 443, con nombre (no una IP) y pública.

Maximum string length: 2048

description

string | null

required

Maximum string length: 200

enabled_events

string[]

required

Los tipos de evento que recibe. Al crear o editar puedes mandar ["*"]: se guarda como la lista de los tipos que tu clave puede leer en ese momento.

status

enum<string>

required

Available options:

enabled,

disabled

disabled_reason

enum<string> | null

required

manual si la desactivó alguien, failing si la desactivó Craqui porque no respondía; null si está activa.

Available options:

manual,

failing,

null

api_version

string

required

La versión de la API con la que se creó.

Pattern: ^\d{4}-\d{2}-\d{2}$

created_at

string<date-time>

required

Instante en RFC 3339 con el offset del negocio en ese momento.

Example:

"2026-12-02T19:00:00-03:00"

updated_at

string<date-time>

required

Instante en RFC 3339 con el offset del negocio en ese momento.

Example:

"2026-12-02T19:00:00-03:00"

secret

string | null

El secreto de firma. Solo viene al crear la URL y al cambiar el secreto, y es la única vez que lo vas a ver: guárdalo. Si repites el pedido con la misma Idempotency-Key, la respuesta guardada trae secret: null; en ese caso, cambia el secreto.

Pattern: ^whsec_[A-Za-z0-9+/=]+$

business

booking_policy

centers

rooms

teachers

courses

classes

credit_packs

membership_plans

intro_offers

sessions

clients

bookings

credits

memberships

fees

payments

refunds

events

webhook_endpoints

Cambiar el secreto de una URL de avisos

Authorizations

Headers

Path Parameters

Body

Response