---
title: "Ping webhook"
method: POST
path: "/webhooks/{webhookId}/ping"
tags: ["Webhooks"]
---

# Ping webhook

`POST /webhooks/{webhookId}/ping`

Send a `PING` event to a webhook by providing its unique identifier.
This is useful for testing and debugging purposes. The event is delivered
asynchronously and its data is returned in the response to this request.

## Path parameters

- `webhookId` string, required

## Response `201`

Successful response

- WebhookEventCallback — Asynchronous callback request used for webhook event delivery.
  - `data` WebhookEventResource, required — Provides the event data used in asynchronous webhook event callbacks to subscribed endpoints. Webhooks events have defined `eventType`s and may optionally relate to other resources within the Up API.
    - `type` string, required — The type of this resource: `webhook-events`
    - `id` string, required — The unique identifier for this event. This will remain constant across delivery retries.
    - `attributes` object, required
      - `eventType` 'TRANSACTION_CREATED' | 'TRANSACTION_SETTLED' | 'TRANSACTION_DELETED' | 'PING', required — Specifies the type of a webhook event. This can be used to determine what action to take in response to the event, such as which relationships to expect.
      - `createdAt` string, date-time, required — The date-time at which this event was generated.
    - `relationships` object, required
      - `webhook` object, required
        - `data` object, required
          - `type` string, required — The type of this resource: `webhooks`
          - `id` string, required — The unique identifier of the resource within its type.
        - `links` object
          - `related` string, required — The link to retrieve the related resource(s) in this relationship.
      - `transaction` object
        - `data` object, required
          - `type` string, required — The type of this resource: `transactions`
          - `id` string, required — The unique identifier of the resource within its type.
        - `links` object
          - `related` string, required — The link to retrieve the related resource(s) in this relationship.

## Changes

> 14 revisions in range; 1 could not be searched.

- **2020-08-15** (v1) `f3c8cf9cc9e6` — 1 warning
  - removed the optional property `data/allOf[#/components/schemas/WebhookEventResource]/links` from the response with the `201` status
- **2020-07-21** (v1) `2ac77a5de971` — 1 info
  - added the optional property `data/allOf[#/components/schemas/WebhookEventResource]/links` to the response with the `201` status

[Change history](https://skmtc.dev/up-banking/apis/up-api/changes/webhooks/:webhookId/ping/post.md)

---

[API](https://skmtc.dev/up-banking/apis/up-api.md) · [All operations](https://skmtc.dev/up-banking/apis/up-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/up-banking/up-api/revisions/cc6a5e6d809d/schema)