Environments

PingWebhook

Sends a test ping event to a webhook on a Pulumi ESC environment to verify that the webhook endpoint is reachable and functioning correctly. This bypasses the normal message queue and issues the request directly to the webhook URL. Returns the WebhookDelivery record containing the HTTP status code and response from the target endpoint.

post/api/preview/environments/{orgName}/{envName}/hooks/{hookName}/ping

Request

  • Base URL: https://api.pulumi.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.pulumi.com/api/preview/environments/{orgName}/{envName}/hooks/{hookName}/ping
  • Auth: none declared

Path parameters

orgNamestring required

The organization name

envNamestring required

The environment name

hookNamestring required

The webhook name

Response

OK

durationinteger required

The duration of the delivery request in milliseconds.

idstring required

The unique identifier of the delivery.

kindstring required

The kind of webhook event.

payloadstring required

The JSON payload that was sent.

requestHeadersstring required

The HTTP headers sent with the request.

requestUrlstring required

The URL the webhook was delivered to.

responseBodystring required

The HTTP response body.

responseCodeinteger required

The HTTP response status code.

responseHeadersstring required

The HTTP response headers.

timestampinteger required

The time the delivery was sent, as a Unix epoch timestamp.

Changes

No recorded changes to this operation across all 1 revision of this API.