Skip to main content

Webhooks

Met webhooks kan VoiceCheap je server op de hoogte stellen zodra er iets gebeurt, zodat je kunt stoppen met pollen GET /v1/translate/{projectId}/status.
Elke levering wordt één keer geprobeerd. Er zijn geen nieuwe pogingen; blijf voor belangrijke gebeurtenissen ook de status opvragen.

Instellen

  1. Open de API-pagina in je VoiceCheap-account.
  2. Kies onder Webhooks voor Generate signing secret. Het geheim met het voorvoegsel whsec_ wordt maar één keer getoond; kopieer het en bewaar het op uw server.
  3. Voer bij Endpoint URL een https-URL in en kies Save.
Dat is alles. Elk project dat je vanaf dat moment start, levert gebeurtenissen aan dat eindpunt.
Webhook-URL’s moeten HTTPS op poort 443 gebruiken en naar een openbaar netwerkadres verwijzen. URL’s met inloggegevens of fragmenten, privé- of gereserveerde adressen en omleidingen worden geweigerd. Dit geldt voor het accountendpoint en voor URL’s die per project worden ingesteld.
Gebruik webhooks_get, webhooks_update en webhooks_delete via de actie-API of MCP. Gebruik webhooks_create_secret alleen via de REST-actie-API. Bewaar het ondertekeningsgeheim veilig wanneer het wordt teruggestuurd; MCP kan deze actie niet uitvoeren of het resultaat ervan opvragen.

Het eindpunt per verzoek overschrijven

POST /v1/translate en POST /v1/projects accepteren een optioneel webhookUrl-veld dat het accounteindpunt alleen voor dat project overschrijft. Dit is handig om staging-verkeer ergens anders heen te sturen: U kunt webhookUrl ook opgeven bij POST /v1/projects/{projectId}/dub om de bestemming van een bestaand project bij te werken.
Het ondertekeningsgeheim is altijd het accountgeheim; alleen de bestemming verandert.

Gebeurtenissen

Er is geen afzonderlijke transcriptiegebeurtenis. Het antwoord op het aanmaken van een project komt voordat de transcriptie is voltooid. project.created wordt pas verzonden nadat het transcript is opgeslagen; u kunt het dan ophalen met POST /v1/projects/{projectId}/transcript.

Payload

Elke aflevering is een POST met een JSON-body:
De payload is bewust beknopt. Roep de REST API aan voor de inhoud zelf.

De handtekening verifiëren

Elke aflevering bevat deze headers: De handtekening dekt <timestamp>.<raw body>, dus deze is bij elke aflevering anders en bewijst zowel dat het verzoek van VoiceCheap kwam als dat de body tijdens het transport niet is gewijzigd.
Verifieer de handtekening voordat u een aflevering vertrouwt. Uw eindpunt is een openbare URL, en de handtekening is wat een echte VoiceCheap-gebeurtenis onderscheidt van al het andere dat het bereikt.

Reageren

Antwoord met een 2xx-status om te bevestigen. Antwoord binnen 10 seconden — bevestig eerst en doe het werk daarna, in plaats van te verwerken voordat u antwoordt. Een niet-2xx-antwoord of een time-out wordt geregistreerd als een mislukte aflevering en wordt vooralsnog niet opnieuw geprobeerd.

Het geheim roteren

Selecteer Roteren op de API-pagina om een nieuw geheim te genereren. Het vorige stopt onmiddellijk met werken, dus implementeer het nieuwe geheim op uw server zodra u roteert. Het verwijderen van de webhook verwijdert zowel het eindpunt als het geheim, en afleveringen stoppen.