VIvieneu
Public API v1

Get one webhook endpoint

Changed on
get/api/v1/webhooks/{endpointId}

Request

  • Base URL
    https://api.vieneu.io
  • Auth
    • API key in header X-API-Key
    • or HTTP bearer

Path parameters

endpointIdstring required

Response

The endpoint. Never includes the signing secret.

idstring required
urlstring required
descriptionstring required
eventsstring[] required
status'ENABLED' | 'DISABLED' required
apiKeyIdstring nullable

Null when the endpoint receives events for every key.

secretPrefixstring required

First characters of the signing secret, so you can tell two secrets apart. The secret itself is returned ONCE, at creation and rotation.

secretRotatedAtstring date-time nullable
lastDeliveryAtstring date-time nullable
lastDeadLetterAtstring date-time nullable

When an event to this endpoint last gave up permanently.

createdAtstring date-time required

Example response

{
  "id": "665f1a2b3c4d5e6f7a8b9c0d",
  "url": "https://api.example.com/hooks/vieneu",
  "description": "Production receiver",
  "events": [
    "tts.job.completed",
    "tts.job.failed"
  ],
  "status": "ENABLED",
  "apiKeyId": "665f1a2b3c4d5e6f7a8b9c0d",
  "secretPrefix": "whsec_a1b2c3",
  "secretRotatedAt": "2026-09-01T10:00:00Z",
  "lastDeliveryAt": "2026-09-01T10:00:00Z",
  "createdAt": "2026-09-01T10:00:00Z"
}

Changes

  • 98838c7c0e72Revision changes
    • info

      added the optional property to the response with the status

  • 633d63e717b8Revision changes
    • breaking

      the response property became optional for the status

    • breaking

      response property message list-of-types was widened by adding types array to media type application/json of response 404

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status