OpenAI API (unofficial showcase)
POST/webhook_endpoints/{webhook_endpoint_id}/test

Test Webhook Endpoint

Sends a sample event to a webhook endpoint for the authenticated project.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 1 body field
webhook_endpoint_idstringrequired
The ID of the webhook endpoint to test.
event_typestringrequired
The event type to send as a sample delivery.
Allowed:batch.completedbatch.failedbatch.expiredbatch.cancelledresponse.completedresponse.failedresponse.cancelledresponse.incompleteeval.run.succeededeval.run.failedeval.run.canceledfine_tuning.job.succeeded

4 status codes
200Success
objectstringrequired
The object type, which is always webhook_endpoint.test.
Allowed:webhook_endpoint.testDefault:webhook_endpoint.test
webhook_endpoint_idstringrequired
The ID of the webhook endpoint that received the test.
event_typestringrequired
The event type sent in the test.
status_codeintegerrequired
The HTTP status code returned by the endpoint.
successbooleanrequired
Whether the test request completed. Always true for returned results; use status_code to determine the endpoint response.
Allowed:trueDefault:true
400The request parameters are invalid.
errorobjectrequired
404The webhook endpoint was not found in the authenticated project.
errorobjectrequired
500The sample event could not be sent to the webhook endpoint.
errorobjectrequired

Error handling

A 400 is returned: The request parameters are invalid. A 404 is returned: The webhook endpoint was not found in the authenticated project. A 500 is returned: The sample event could not be sent to the webhook endpoint.