Ping an event destination v2

Core Resources
Events
Ping an event destination

Send a ping event to an event destination.

Learn more about calling API v2 endpoints.

Parameters

  • idstringRequired

    Identifier for the event destination to ping.

Returns

Response attributes

  • idstring

    Unique identifier for the event.

  • objectstring, value is "v2.core.event"

    String representing the object’s type. Objects of the same type share the same value of the object field.

  • contextnullable string

    Authentication context needed to fetch the event or related object.

  • createdtimestamp

    Time at which the object was created.

  • datanullable object

    Additional data about the event.

  • livemodeboolean

    Has the value true if the object exists in live mode or the value false if the object exists in test mode.

  • reasonnullable object

    Reason for the event.

    • reason.requestnullable object

      Information on the API request that instigated the event.

      • reason.request.idstring

        ID of the API request that caused the event.

      • reason.request.idempotency_keystring

        The idempotency key transmitted during the request.

    • reason.typeenum

      Event reason type.

      Possible enum values
      request

      The event was published as the result of an API request.

  • related_objectnullable object

    Object containing the reference to API resource relevant to the event.

    • related_object.idstring

      Unique identifier for the object relevant to the event.

    • related_object.typestring

      Object tag of the resource relevant to the event.

    • related_object.urlstring

      URL to retrieve the resource.

  • typestring

    The type of the event.

Error Codes
404not_found

The resource wasn’t found.

POST /v2/core/event_destinations/:id/ping
curl -X POST https://api.stripe.com/v2/core/event_destinations/evt_test_65RM8sQH2oXnebF5Rpc16RJyfa2xSQLHJJh1sxm7H0KI92/ping \
-H "Authorization: Bearer sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2" \
-H "Stripe-Version: 2025-08-27.preview"
Response
{
"id": "evt_test_65RM8sQH2oXnebF5Rpc16RJyfa2xSQLHJJh1sxm7H0KI92",
"object": "v2.core.event",
"context": null,
"created": "2024-10-22T16:26:54.063Z",
"data": null,
"livemode": false,
"reason": null,
"related_object": {
"id": "ed_test_61RM8ltWcTW4mbsxf16RJyfa2xSQLHJJh1sxm7H0KVT6",
"type": "event_destination",
"url": "/v2/core/event_destinations/ed_test_61RM8ltWcTW4mbsxf16RJyfa2xSQLHJJh1sxm7H0KVT6"
},
"type": "v2.core.event_destination.ping"
}