Skip to main content
POST
Maak of roteer het ondertekeningsgeheim voor webhooks van je persoonlijke account. Retourneert het nieuwe geheim één keer; bewaar het veilig. Roteren maakt het vorige geheim ongeldig.

Authenticatie en machtigingen

string
vereist
Stuur een VoiceCheap API-sleutel mee in deze header. Authorization: Bearer met dezelfde API-sleutel wordt ook ondersteund. OAuth-toegangstokens worden alleen door MCP geaccepteerd, niet door dit REST-endpoint.
Vereiste machtigingen: webhooks:write. Een actief betaald abonnement is vereist. Machtigingen wijzigen geen teamrollen, eigendom van resources, mediategoed of abonnementslimieten.

Parameters

string
Optioneel op transportniveau: als de identificatie ontbreekt, voegt de server deze vóór de validatie toe. Geef zelf een stabiele UUID v4 op om veilig te kunnen herstellen als een antwoord verloren gaat.Formaat: “uuid”. Patroon: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$.
Het onderstaande JSON Schema behoudt de exacte veldnamen, geneste typen, standaardwaarden, grenzen en toegestane waarden die discovery beschikbaar stelt. Aanvullende regels tussen velden staan in de opmerkingen bij de bewerking.

Idempotentie

Gebruik voor elke wijziging een UUID v4 in requestId of de HTTP-header Idempotency-Key. Gebruik na een netwerkfout dezelfde identificatie en identieke argumenten opnieuw. Als je beide opgeeft, moeten ze overeenkomen. Het opnieuw versturen van een opgeslagen aanvraag herhaalt de bewerking niet en verbruikt geen extra maandelijkse aanroep. Mislukte of onderbroken aanvragen worden niet automatisch opnieuw gestart. Elke wijziging kan HTTP 202 retourneren wanneer een nieuwe poging vaststelt dat dezelfde aanvraag nog loopt, ook wanneer de eerste uitvoering normaal synchroon is. Als de uitvoering is voltooid maar resultStored false is, retourneert een nieuwe poging HTTP 200 met de opgeslagen aanvraagstatus in plaats van het oorspronkelijke resultaat. Haal de uitvoer op via de geschiedenis-, resultaat- of downloadactie van het betreffende domein.

Voorbeeldaanvragen

Vervang de voorbeeldidentificaties van resources en mediasleutels door waarden die voor je account zijn geretourneerd. Behoud dezelfde aanvraagidentificatie wanneer je dezelfde wijziging opnieuw probeert.

Antwoord

Een geslaagde eerste uitvoering retourneert HTTP 200 met het resultaat van de bewerking onder data. Een herhaalde aanvraag kan in plaats daarvan de opgeslagen aanvraagstatus retourneren. Het voorbeeld toont één ondersteund antwoord, niet alle optionele velden. Retourneert de webhookinstellingen en het nieuw aangemaakte ondertekeningsgeheim.

Resultaatvelden

Deze aanvraag herstellen en controleren

Gebruik dezelfde identificatie, ook nadat de verbinding is verbroken. Als resultStored false is, haal je de uitvoer op via de bijbehorende geschiedenis-, resultaat- of downloadactie. Start nooit een tweede generatie alleen om de voortgang te controleren.
HTTP 200

Opmerkingen bij de bewerking

  • webhooks_create_secret is alleen via REST beschikbaar en wordt niet via MCP ontdekt. Aanroepen of het resultaat opvragen via MCP geeft de toolfout ACTION_NOT_AVAILABLE_IN_MCP. Ondertekeningsgeheimen worden niet naar assistenten verstuurd.
  • Als je een geheim aanmaakt terwijl er al een bestaat, wordt het geroteerd en wordt het vorige geheim direct ongeldig.
  • De bestaande webhook-URL blijft behouden. Bij het eerste geheim is url een lege tekenreeks totdat deze is geconfigureerd.
  • Gebruik een unieke requestId voor de beoogde rotatie en hergebruik diezelfde ID bij nieuwe pogingen, zodat een verloren respons niet nog een rotatie veroorzaakt.

Verbruik

Elke geslaagde aanroep verbruikt één maandelijkse API/MCP-aanroep. Ook het mediategoed en de eigen generatielimieten van de bewerking zijn van toepassing.

Fouten