Send a test event
Sends a signed ping event to this endpoint only and answers 202 with the delivery that carries it. Read the outcome from GET /v1/webhook-endpoints/{id}/deliveries. An endpoint can be tested 5 times a minute.
Required scope: webhooks:write.
Errors
- 400:
invalid_idempotency_key,unknown_field - 401:
authentication_required,invalid_api_key - 403:
api_access_disabled,insufficient_scope,webhooks_not_enabled - 404:
webhook_endpoint_not_found - 409:
idempotency_key_reused,idempotency_request_in_progress,webhook_endpoint_paused - 422:
invalid_parameter - 429:
rate_limit_exceeded - 500:
api_error - 503:
maintenance_mode,service_unavailable
ApiKeyAuthorizationBearer <probb_live_<id>_<secret>>id*stringThe webhook endpoint's ID.
1 <= length <= 200Idempotency-Key?stringMakes retries safe. Repeating a request with the same key and body within 24 hours returns the original response with Idempotent-Replayed: true. The same key with a different body, or from a different API key, returns idempotency_key_reused.
1 <= length <= 255Success.
application/json- response
object*stringid*stringThe delivery's ID, for retrying it.
endpointId*stringThe endpoint it is sent to.
eventId*stringThe event it carries.
eventType*stringThe event's type, for example report.completed.
actor*|Who caused the event. Null for events recorded before actors existed.
status*stringpending until your server answers 2xx (retries wait for nextAttemptAt), succeeded, failed once the retries are used up, or cancelled when the endpoint's URL changed or it was deleted first.
"pending""running""succeeded""failed""cancelled"attemptCount*integerHow many times it has been sent.
-9007199254740991 <= value <= 9007199254740991nextAttemptAt*|When the next attempt is due. Null once the delivery is finished.
createdAt*stringWhen the delivery was queued.
date-timeattempts*array<>The most recent attempts, newest first.
# Set PROBB_URL and PROBB_API_KEY. Replace any *_VALUE placeholder and any example ID (such as job_example) with a real one.# Idempotency-Key is optional. Reuse the same key and body when retrying one logical write.curl --fail-with-body -X POST "$PROBB_URL/api/v1/webhook-endpoints/ID_VALUE/test" \ -H "Authorization: Bearer $PROBB_API_KEY" \ -H "Idempotency-Key: $REQUEST_KEY"{ "object": "webhook_delivery", "id": "string", "endpointId": "string", "eventId": "string", "eventType": "string", "actor": { "type": "api_key", "id": "string" }, "status": "pending", "attemptCount": -9007199254740991, "nextAttemptAt": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z", "attempts": [ { "number": -9007199254740991, "startedAt": "2019-08-24T14:15:22Z", "httpStatus": -9007199254740991, "outcome": "string", "durationMs": -9007199254740991 } ]}