Endpoint: Webhooks

Receive real-time event notifications from VeriPrompt.

Create a Webhook

POST /api/v1/webhooks
Auth: Session

{
  "name": "My Integration",
  "url": "https://example.com/webhooks/veriprompt",
  "events": ["prompt.executed", "gateway.executed"],
  "secret": "my-secret-at-least-16-characters"
}

Required Fields

Field	Type	Constraints
name	string	Display name for the webhook
url	string	Must be a valid HTTPS URL
events	string[]	At least one event type

Optional Fields

Field	Type	Constraints
secret	string	HMAC signing secret. Minimum 16 characters. Auto-generated if omitted.

Important: The field name is events (not eventTypes).

List Webhooks

GET /api/v1/webhooks
Auth: Session or Gateway Key

Returns all registered webhooks for your company.

Delete a Webhook

DELETE /api/v1/webhooks/{webhookId}
Auth: Session

Delivery History

GET /api/v1/webhooks/deliveries
Auth: Session

View delivery attempts and their status.

Limitations

• Individual webhook retrieval (GET /api/v1/webhooks/{id}) is not currently supported.
• Individual webhook updates (PUT /api/v1/webhooks/{id}) are not currently supported.
• To modify a webhook, delete and recreate it.

Related Docs

• Webhook Integration Guide - Full guide with signature verification and code examples
• Error Handling