Sign in

v1

latestOpenAPI 3.0.02026-08-0679302767.4 KB
Webhooks

Register Webhook (Credentialing Events)

Register a webhook for credentialing events of a provider. If headers are included, they will be sent with every request. If oauth_configuration is set, the token_url will be called with client_id and client_secret and a form urlencoded POST request to generate an access token. The response includes the webhook ID and configuration details.

post/v2/webhooks

Headers

organization-idstring

Request body

urlstring required

Callback URL to which data should be posted

event_typesstring[] required

Webhook event(s) that should trigger a post.

Values:

  • IN_PROGRESS: Credentialing is in progress
  • PSV_COMPLETED: Primary source verification completed
  • CREDENTIALING_COMPLETED: Credentialing completed
  • PROVIDER_TERMINATED: Provider terminated
  • FACILITY_NOT_SENT_TO_CREDENTIALING: Facility not sent to credentialing
  • FACILITY_IN_PROGRESS: Facility credentialing in progress
  • FACILITY_DATA_MISSING: Facility data missing
  • FACILITY_OUTREACH_IN_PROGRESS: Facility outreach in progress
  • FACILITY_PSV_COMPLETE_BY_CERTIFYOS: Facility PSV complete by CertifyOS
  • FACILITY_CREDENTIALING_RESTARTED: Facility credentialing restarted
  • FACILITY_PSV_READY: Facility PSV ready
  • FACILITY_CRED_APPROVED: Facility credentialing approved
  • FACILITY_HOLD_FOR_CRED_COMM: Facility hold for credentialing committee
  • FACILITY_CRED_DENIED: Facility credentialing denied
  • FACILITY_TERMINATED: Facility terminated
  • FACILITY_RECREDENTIALING_IN_PROGRESS: Facility recredentialing in progress
  • FACILITY_TABLED: Facility tabled
  • FACILITY_WITHDRAWN_CANCELLED: Facility withdrawn or cancelled
  • FACILITY_NOT_STARTED: Facility credentialing not started
  • PROVIDER_NOT_SENT_TO_CREDENTIALING: Provider not sent to credentialing
  • PROVIDER_NOT_STARTED: Provider credentialing not started
  • PROVIDER_IN_PROGRESS: Provider credentialing in progress
  • PROVIDER_DATA_MISSING: Provider data missing
  • PROVIDER_OUTREACH_IN_PROGRESS: Provider outreach in progress
  • PROVIDER_PSV_COMPLETED: Provider PSV completed
  • PROVIDER_CREDENTIALING_RESTARTED: Provider credentialing restarted
  • PROVIDER_PSV_READY: Provider PSV ready
  • PROVIDER_CRED_APPROVED: Provider credentialing approved
  • PROVIDER_HOLD_FOR_CRED_COMM: Provider hold for credentialing committee
  • PROVIDER_CRED_DENIED: Provider credentialing denied
  • PROVIDER_RECREDENTIALING_IN_PROGRESS: Provider recredentialing in progress
  • PROVIDER_TABLED: Provider tabled
  • PROVIDER_WITHDRAWN_CANCELLED: Provider withdrawn or cancelled
  • FORM_SUBMISSION_CREATED: Form submission created
descriptionstring

Title/description of the webhook being registered

headersobject

Key-value pairs of custom static headers sent with the webhook requests (e.g., for API keys or tokens). To send headers in the OAuth token exchange, set the oauth_configuration.headers property.

Example request

{
  "url": "https://yourdomain.com/webhook-endpoint",
  "description": "Provider Created Webhook",
  "headers": {
    "X-Api-Key": "abcdef123456"
  },
  "oauth_configuration": {
    "client_id": "my-client-id",
    "client_secret": "my-client-secret",
    "token_url": "https://auth.example.com/oauth/token",
    "scope": "resource.read",
    "headers": {
      "X-Domain-Name": "example.com"
    }
  }
}

Response

Webhook Created Successfully

idstring required