---
title: "Get webhook messages by webhook external ID"
method: GET
path: "/v1/webhook/{webhookExternalId}/message"
tags: ["Webhooks"]
---

# Get webhook messages by webhook external ID

`GET /v1/webhook/{webhookExternalId}/message`

## Path parameters

- `webhookExternalId` string, required

## Query parameters

- `page` integer
- `status` 'PENDING' | 'SUCCESSFUL' | 'FAILED' | 'WILL_NOT_SEND'
- `resource_id` string

## Response `200`

OK

- WebhookMessageSearchResponse
  - `count` integer — The number of results in the current page
  - `page` integer — The page of results
  - `results` WebhookMessageResponse[]
    - `created_date` string, date-time
    - `event_date` string, date-time
    - `event_type` 'card_payment_started' | 'card_payment_succeeded' | 'card_payment_captured' | 'card_payment_refunded' | 'card_payment_failed' | 'card_payment_expired'
    - `external_id` string
    - `last_delivery_status` 'PENDING' | 'SUCCESSFUL' | 'FAILED' | 'WILL_NOT_SEND'
    - `latest_attempt` WebhookDeliveryQueueResponse
      - `created_date` string, date-time
      - `response_time` integer
      - `result` string
      - `send_at` string, date-time
      - `status` 'PENDING' | 'SUCCESSFUL' | 'FAILED' | 'WILL_NOT_SEND'
      - `status_code` integer
    - `resource` JsonNode
    - `resource_id` string
    - `resource_type` string
  - `total` integer — The total number of results

## Changes

- **2025-02-25** `e7d174740a84` — 1 info
  - added the optional property `total` to the response with the `200` status
- **2023-05-03** `f583a561523b` — 1 info
  - added the new optional `query` request parameter `resource_id`
- **2023-03-16** `d695db3a1eea` — 1 warning
  - removed the optional property `total` from the response with the `200` status
- **2023-03-01** `a8ce27cb4fbb` — 1 info
  - added the optional property `results/items/last_delivery_status` to the response with the `200` status

[Change history](https://skmtc.dev/government-digital-service/apis/webhooks-api/changes/v1/webhook/:webhookExternalId/message/get.md)

---

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