Skip to main content
POST
/
v1
/
webhooks
Create a Webhook
curl --request POST \
  --url https://api.example.com/v1/webhooks

​
Description

This endpoint establishes a webhook for receiving notifications about events within the Transcrypts platform. Webhooks support the broader platform lifecycle by enabling real-time notifications for connection status changes, data refresh completion, and employment verification events.

​
Authentication

The endpoint requires API credentials passed via request headers:
  • Client ID (header)
  • Access Key (header)

​
Request Body

The request body accepts webhook configuration parameters in JSON format.
ParameterTypeRequiredDescription
namestringYesPublic webhook configuration name
webhook_urlstringYesURL where event data is sent
eventsarrayYesList of event types to subscribe to
env_typestringNoEnvironment: production or development

​
Response

​
Success Response (201 Created)

The API returns a 201 status code upon successful webhook creation, confirming the webhook has been registered.

​
Error Responses

400 Bad Request: Returned when request parameters are malformed or incomplete. 401 Unauthorized: Authentication credentials missing or invalid. 403 Forbidden: Insufficient permissions for webhook creation.