get https://api.ocrolus.com/v1/account/settings/test_webhook_endpoint
Send a test payload to your webhook to ensure that it's working correctly.
The test sends a POST
request to the configured webhook with the following payload:
{
"status": "VERIFICATION_COMPLETE",
"uploaded_doc_pk": 0,
"book_pk": 0
}
The test is deemed successful when your webhook responds with a status of 200 OK
.
A successful response contains a brief message indicating this success. If the webhook fails for any reason, the corresponding HTTP status code and message are provided in the message
and code
attributes.