Sign in
latestOpenAPI 3.1.02026-08-194237902.5 MB

563848e0ecc0

Webhook

Create a new webhook

Creates a new webhook subscription with the provided details. The webhook will receive events asynchronously when the specified event types occur.

Available Event Types:

  • credential_workflow.status.changed - Triggered automatically when a credentialing workflow status changes (timeline event is created). See webhook-api-credential-workflow-events.md for detailed payload structure and documentation.

  • facility_credential_workflow.status.changed - Triggered automatically when a facility credentialing workflow status changes (timeline event is created).

  • form.submission.submitted - Triggered when a form submission is received by POST /forms/submissions.

You can subscribe to multiple different event types in a single webhook.

post/webhooks

Headers

tenant-idstring required

Tenant ID

Request body

webhookUrlstring required

The URL where webhook events will be sent

eventTypesWebhookEventType[] required

List of event types that this webhook should receive. You can subscribe to multiple different event types in a single webhook.

Available Event Types:

  • credential_workflow.status.changed - Triggered automatically when a credentialing workflow status changes (timeline event is created). See webhook-api-credential-workflow-events.md for detailed payload structure and documentation.

  • facility_credential_workflow.status.changed - Triggered automatically when a facility credentialing workflow status changes.

  • form.submission.submitted - Triggered when a form submission is received by POST /forms/submissions.

headersobject

Custom headers to include in webhook requests

isActiveboolean

Whether the webhook is active. Defaults to true if not provided

Example request

{
  "webhookUrl": "https://example.com/webhook",
  "eventTypes": [
    "credential_workflow.status.changed",
    "facility_credential_workflow.status.changed",
    "form.submission.submitted"
  ],
  "headers": {
    "Authorization": "Bearer token",
    "X-Custom-Header": "custom-value"
  },
  "isActive": true,
  "oauthConfiguration": {
    "tokenUrl": "https://auth.example.com/oauth/token",
    "resource": "resource"
  }
}

Response

Successfully created the webhook

idstring

Unique identifier for the webhook

tenantIdstring

ID of the tenant

createdBystring

ID of the user who created the webhook

updatedBystring

ID of the user who updated the webhook

createdAtstring date-time
updatedAtstring date-time

Example response

{
  "id": "webhook-123",
  "tenantId": "tenant-123",
  "createdBy": "user-123",
  "updatedBy": "user-123",
  "createdAt": "2022-03-10T16:15:50Z",
  "updatedAt": "2022-03-10T16:15:50Z"
}