Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

PP-13369: Information about webhooks retry mechanism #985

Merged
merged 2 commits into from
Dec 18, 2024
Merged

PP-13369: Information about webhooks retry mechanism #985

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6bf62fb
PP-13369: adds information about webhooks retries
NathanD-GDS Dec 18, 2024
9ef5497
Changes following tech writer 2i
NathanD-GDS Dec 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion source/webhooks/index.html.md.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,12 @@ When your webhook receives a message, it’ll look like this:

### Retry mechanism

If your service does not return a `2xx` successful response quickly after receiving a webhook message, we’ll try to send the message again. After several attempts, we'll stop retrying.
GOV.UK Pay sends each webhook message at least once.

If we receive a `2xx` successful response from your service, we will not try to send the webhook message again.

If we do not receive a `2xx` successful response from your service quickly after sending a webhook message, we’ll try to send the message again. After several attempts, we'll stop trying.

Sometimes, your service will return a successful response but we might not receive it and will try to send the webhook message again. Your integration should be able to handle receiving the same webhook message more than once.

You can see the history of payment events and the message delivery status of each event by selecting **Manage webhook** in [the GOV.UK Pay admin tool](https://selfservice.payments.service.gov.uk/). Each line of the **Events history** table is a single event. Select a payment event to see details of that event, including when it was sent, the body of the webhook message, and any previous delivery attempts.
Loading