Skip to content
CertifyOS API
/
/
Register Webhook (Credent...

CertifyOS API

Download OpenAPI description
api.json
api.yaml
Overview
Languages
Servers
Mock server
https://docs.certifyos.com/_mock/reference/application/api/
Production
https://ng-api-production.certifyos.com/
Staging (Test Data)
https://ng-api-stg.certifyos.com/

auth-tokens

Operations

credentialing-workflows

Operations

v2/credentialing-workflows

Operations

providers

Operations

v2/provider

Operations

v2/providers

Operations

v2/flags

Operations

v2/provider-with-groups

Operations

flags

Operations

v2/groups

Operations

Webhooks

Operations

Retrieve all registered webhooks

Request

Retrieve all webhooks registered for the organization, including basic configuration details. Sensitive information like oauth_configuration will be masked in the response.

Security
BearerAuth
Headers
organization-idstring
curl -i -X GET \
  https://docs.certifyos.com/_mock/reference/application/api/v2/webhooks \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'organization-id: string'

Responses

List of registered webhooks retrieved successfully

Bodyapplication/jsonArray [
idstringrequired

Unique identifier for the webhook registration

organization_idstringrequired

Unique identifier for the client organization

urlstringrequired

Callback URL to which data should be posted

Example: "https://yourdomain.com/webhook-endpoint"
event_typesArray of stringsrequired

Credentialing 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
Items Enum"IN_PROGRESS""PSV_COMPLETED""CREDENTIALING_COMPLETED""PROVIDER_TERMINATED""FACILITY_NOT_SENT_TO_CREDENTIALING""FACILITY_IN_PROGRESS""FACILITY_DATA_MISSING""FACILITY_OUTREACH_IN_PROGRESS""FACILITY_PSV_COMPLETE_BY_CERTIFYOS""FACILITY_CREDENTIALING_RESTARTED"
descriptionstring

Title/description of the webhook being registered

Example: "Provider Created Webhook"
headersobject

Key-value pairs of custom static headers sent with the webhook requests (e.g., for API keys or tokens). These are masked in the response.

Example: {"X-Api-Key":"****"}
oauth_configurationobject

OAuth2 client credentials configuration for token-based authentication. These are masked in the response.

Example: {"client_id":"my-client-id","client_secret":"****","token_url":"https://auth.example.com/oauth/token"}
created_atstringrequired

Timestamp when the webhook was created

]
Response
application/json
[
  {
    "id": "string",
    "organization_id": "string",
    "url": "https://yourdomain.com/webhook-endpoint",
    "event_types": [ … ],
    "description": "Provider Created Webhook",
    "headers": { … },
    "oauth_configuration": { … },
    "created_at": "string"
  }
]

Register Webhook (Credentialing Events)

Request

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.

Security
BearerAuth
Headers
organization-idstring
Bodyapplication/jsonrequired
urlstringrequired

Callback URL to which data should be posted

Example: "https://yourdomain.com/webhook-endpoint"
event_typesArray of stringsrequired

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
Items Enum"IN_PROGRESS""PSV_COMPLETED""CREDENTIALING_COMPLETED""PROVIDER_TERMINATED""FACILITY_NOT_SENT_TO_CREDENTIALING""FACILITY_IN_PROGRESS""FACILITY_DATA_MISSING""FACILITY_OUTREACH_IN_PROGRESS""FACILITY_PSV_COMPLETE_BY_CERTIFYOS""FACILITY_CREDENTIALING_RESTARTED"
descriptionstring

Title/description of the webhook being registered

Example: "Provider Created Webhook"
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: {"X-Api-Key":"abcdef123456"}
oauth_configurationobject

OAuth2 client credentials configuration for token-based authentication.

Example: {"client_id":"my-client-id","client_secret":"my-client-secret","token_url":"https://auth.example.com/oauth/token"}
curl -i -X POST \
  https://docs.certifyos.com/_mock/reference/application/api/v2/webhooks \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'organization-id: string' \
  -d '{
    "url": "https://yourdomain.com/webhook-endpoint",
    "event_types": [
      "IN_PROGRESS"
    ],
    "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"
    }
  }'

Responses

Webhook Created Successfully

Bodyapplication/json
idstringrequired
Response
application/json
{
  "id": "string"
}

Remove Registered Webhook

Request

Remove a previously registered webhook by providing its configuration.

Security
BearerAuth
Headers
organization-idstring
Bodyapplication/jsonrequired
idstringrequired

ID assigned to the Webhook

curl -i -X DELETE \
  https://docs.certifyos.com/_mock/reference/application/api/v2/webhooks \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'organization-id: string' \
  -d '{
    "id": "string"
  }'

Responses

Webhook deleted successfully.

Response
No content

Test a registered webhook

Request

Send a test event to a registered webhook. This is useful for verifying that the webhook endpoint is reachable and correctly configured.

Security
BearerAuth
Path
webhookIdstringrequired

Webhook ID returned when registering a webhook

Example: webhook_123
Headers
organization-idstring
Bodyapplication/jsonrequired
messagestringrequired

Message to include in the test event sent to the webhook

eventTypestringrequired

Event type for the test event sent to the webhook

Enum"IN_PROGRESS""PSV_COMPLETED""CREDENTIALING_COMPLETED""PROVIDER_TERMINATED""FACILITY_NOT_SENT_TO_CREDENTIALING""FACILITY_IN_PROGRESS""FACILITY_DATA_MISSING""FACILITY_OUTREACH_IN_PROGRESS""FACILITY_PSV_COMPLETE_BY_CERTIFYOS""FACILITY_CREDENTIALING_RESTARTED"
curl -i -X POST \
  https://docs.certifyos.com/_mock/reference/application/api/v2/webhooks/webhook_123/test-event \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'organization-id: string' \
  -d '{
    "message": "string",
    "eventType": "IN_PROGRESS"
  }'

Responses

Webhook test event sent successfully

Bodyapplication/json
any
Response
application/json
{
  "message": "Test event sent successfully"
}

forms

Operations

v2/facility-credentialing-workflows

Operations

v2/facilities

Operations