Ping webhook

POST///

Pings your webhook endpoint. Send a ping request to your webhook endpoint to validate credentials and connectivity. Your webhook endpoint must be configured to respond.

Configuring your webhook endpoint

When the Marqeta platform receives the ping request, it sends a POST request containing the following body to the URL of your webhook endpoint:

JSON

{
  "pings": [
    {
      "token": "marqeta",
      "payload": "healthcheck"
    }
  ]
}

To indicate that it is functioning properly, your webhook endpoint must respond with a status code of 200 (see Signature Verification for a code example that identifies a ping request). The response can optionally include a JSON-formatted body, for example:

JSON

{"my_endpoint_status": "alive"}

The Marqeta platform then responds to its requestor by echoing, as-is, the response code and body received from your webhook endpoint.

Using the ping facility

To ping a webhook endpoint, send a POST request to /webhooks/{token}/ping and use the token path parameter to specify which webhook you want to reach. Include an empty, JSON-formatted body in the request, that is:

JSON

{}

The following chain of actions occurs during the successful execution of a ping operation:

The Marqeta platform receives the ping request (POST to /webhooks/{token}/ping).

The Marqeta platform sends a request to your webhook endpoint.

Your webhook endpoint responds with a status code of “200” and an optional body.

The Marqeta platform responds to its requestor by echoing, as-is, the response code and body it received from your webhook endpoint.

Note
If the customer-hosted endpoint fails to respond within five seconds, the Marqeta platform times out the request and responds with the following message body (where <optional message> represents additional details you can choose to include in the response):

JSON

{
  "error_message": "Webhook operation failed " + <optional message>,
  "error_code": "422600"
}

Failed pings are not automatically retried.

URL path parameters

Fields	Description
token string Required	Unique identifier of the webhook. Allowable Values: Existing webhook token

Response body

Fields	Description
pings array of objects Returned	Array of ping requests to your webhook endpoint. Allowable Values: Valid array of one or more `ping` requests
pings[].payload string Conditionally returned	Payload of the ping request. Allowable Values: 255 char max
pings[].token string Conditionally returned	Unique identifier of the ping request. Allowable Values: 255 char max

Sample response body

JSON

{
  "pings": [
    {
      "my_endpoint_status": "alive"
    }
  ]
}

Getting Started

Testing

Card Issuing

Card Processing

Accounts & Money Movement

Risk, Fraud, and Disputes

Cardholder User Experience

Configuring your webhook endpoint

Using the ping facility

URL path parameters

Response body

Sample response body

​Configuring your webhook endpoint

​Using the ping facility

​URL path parameters

​Response body

​Sample response body

Configuring your webhook endpoint

Using the ping facility

URL path parameters

Response body

Sample response body