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-11369: Adds information about webhook callback URL restrictions #943

Merged
merged 4 commits into from
Dec 18, 2023
Merged

PP-11369: Adds information about webhook callback URL restrictions #943

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
528e3c2
Adds information about webhook callback URL restrictions
NathanD-GDS Dec 18, 2023
735ee31
Small changes
NathanD-GDS Dec 18, 2023
a9bb287
Adds a missing dot
NathanD-GDS Dec 18, 2023
1393447
Adds more detail to domain approval delay line
NathanD-GDS Dec 18, 2023
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
4 changes: 4 additions & 0 deletions source/webhooks/index.html.md.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,10 @@ You must set up your endpoint to receive the `POST` body from your webhook and r

Your callback URL must use HTTPS and present a valid certificate. GOV.UK webhooks support TLS version 1.2.

Your callback URL must have a domain that ends with `.gov.uk`. This restriction does not apply if you're using webhooks on a test service.

We can allow other domains if you cannot host your callback URL on a domain that ends with `.gov.uk`. You can ask us to allow a domain by emailing support at [[email protected]](mailto:[email protected]). We'll only allow domains that exclusively belong to your service or your service's parent organisation. There may be a delay before we allow your domain to give us time to discuss your request.

## Create a webhook

You can create a webhook for your service from the [GOV.UK Pay admin tool](https://selfservice.payments.service.gov.uk/login).
Expand Down