Esc

↵Open

Creates a WebhookEndpoint resource.

POST

/api/webhook_endpoints/{id}/ping

POST

/api/webhook_endpoints/{id}/ping

curl -X POST "/api/webhook_endpoints/{id}/ping" \
  -H "apikey: $MEDIALISTER_CLIENT_API_KEY"

Authorization

apikey
string
header
required
Value for the apikey header parameter.

Parameters

id
string
path
required
WebhookEndpoint identifier

Response

application/ld+json

WebhookEndpoint resource created

@context
one of
@id
string
required
@type
string
required
attempt
integer
sentAt
string<date-time>
successful
boolean
pong
boolean
Whether the answer passes the setup check: 2xx with the body pong (pings only).
httpStatus
integer | null
The receiver's HTTP status; null when it could not be reached.
durationMs
integer
error
string | null
Why the receiver could not be reached (timeout, DNS, refused address).

{
  "@context": "string",
  "@id": "string",
  "@type": "string",
  "attempt": 0,
  "sentAt": "2026-01-15T09:30:00Z",
  "successful": true,
  "pong": true,
  "httpStatus": 0,
  "durationMs": 0,
  "error": "string"
}