OMomnistack-sh

Test Webhook Endpoint

Changed on

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

post/webhook_endpoints/{webhook_endpoint_id}/test

Request

  • Base URL
    https://api.openai.com/v1
  • URL
    https://api.openai.com/v1/webhook_endpoints/{webhook_endpoint_id}/test
  • Auth
    HTTP bearer

Path parameters

webhook_endpoint_idstring required
Example:whe_123

The ID of the webhook endpoint to test.

Request body

event_type'batch.completed' | 'batch.failed' | 'batch.expired' | 'batch.cancelled' | 'response.completed' | 'response.failed' | 'response.cancelled' | 'response.incomplete' | 'eval.run.succeeded' | 'eval.run.failed' | 'eval.run.canceled' | 'fine_tuning.job.succeeded' | 'fine_tuning.job.failed' | 'fine_tuning.job.cancelled' | 'realtime.call.incoming' | 'video.completed' | 'video.failed' | 'agent.environment.ready' | 'agent.environment.failed' | 'agent.environment.suspended' | 'agent.environment.expired' | 'agent.session.created' | 'agent.session.action_required' | 'agent.session.in_progress' | 'agent.session.idle' | 'agent.session.failed' | 'safety.alert.created' required

Response

Success

object'webhook_endpoint.test' required

The object type, which is always webhook_endpoint.test.

webhook_endpoint_idstring required

The ID of the webhook endpoint that received the test.

event_typestring required

The event type sent in the test.

status_codeinteger required

The HTTP status code returned by the endpoint.

successtrue required

Whether the test request completed. Always true for returned results; use status_code to determine the endpoint response.

Changes

  • ff5a4408cabbRevision changes
    • info

      added the new agent.environment.expired enum value to the request property

    • info

      added the new agent.environment.suspended enum value to the request property

  • 30eea8389a06Revision changes
    • info

      added the new agent.environment.failed enum value to the request property

    • info

      added the new agent.environment.ready enum value to the request property