Overview

it solely exists to allow me to test things related to webhooks


Documents

swagger.json
Uploaded schema

Who can use this API

anyone, it doesnt do anything.


Service level

immediately, or atleast pretty quickly


Technologies

The technology in use is the testing of webhooks!


Environments

Environment Base URL
live https://dev-api.education.gov.uk/testingwebhooks/1

You need to sign in to subscribe to an API environment or view your existing subscriptions.

Sign in here using GOV.UK One Login


Groups

API groups allow you to connect to multiple APIs or versions of an API with a single set of credentials. This API is a member of the following groups:

Group name Description
Webhooks Test API Group

this api group contains apis devised for testing the webhooks feature

Current release

Release name Available from
release1 28 August 2025

Operations

POST Deleted establishment

Description

Deleted establishment

URL template
/establishments/deleted
Show / Hide additional information

Request Model Example

{
  "ValueKind": 1
}

Response Codes

Status code Description
202 Accepted
400 Invalid event data

Example Request

curl -X POST \
  "https://dev-api.education.gov.uk/testingwebhooks/1/establishments/deleted" \
  -H "Content-Type: application/json" \
  -d '{
  "ValueKind": 1
}'

POST Deleted group

Description

Deleted group

URL template
/governors/deleted
Show / Hide additional information

Request Model Example

{
  "ValueKind": 1
}

Response Codes

Status code Description
202 Accepted
400 Invalid event data

Example Request

curl -X POST \
  "https://dev-api.education.gov.uk/testingwebhooks/1/governors/deleted" \
  -H "Content-Type: application/json" \
  -d '{
  "ValueKind": 1
}'

POST Deleted group

Description

Deleted group

URL template
/groups/deleted
Show / Hide additional information

Request Model Example

{
  "ValueKind": 1
}

Response Codes

Status code Description
202 Accepted
400 Invalid event data

Example Request

curl -X POST \
  "https://dev-api.education.gov.uk/testingwebhooks/1/groups/deleted" \
  -H "Content-Type: application/json" \
  -d '{
  "ValueKind": 1
}'

POST New establishment

Description

New establishment

URL template
/establishments/created
Show / Hide additional information

Request Model Example

{
  "ValueKind": 1
}

Response Codes

Status code Description
202 Accepted
400 Invalid event data

Example Request

curl -X POST \
  "https://dev-api.education.gov.uk/testingwebhooks/1/establishments/created" \
  -H "Content-Type: application/json" \
  -d '{
  "ValueKind": 1
}'

POST New group

Description

New group

URL template
/governors/created
Show / Hide additional information

Request Model Example

{
  "ValueKind": 1
}

Response Codes

Status code Description
202 Accepted
400 Invalid event data

Example Request

curl -X POST \
  "https://dev-api.education.gov.uk/testingwebhooks/1/governors/created" \
  -H "Content-Type: application/json" \
  -d '{
  "ValueKind": 1
}'

POST New group

Description

New group

URL template
/groups/created
Show / Hide additional information

Request Model Example

{
  "ValueKind": 1
}

Response Codes

Status code Description
202 Accepted
400 Invalid event data

Example Request

curl -X POST \
  "https://dev-api.education.gov.uk/testingwebhooks/1/groups/created" \
  -H "Content-Type: application/json" \
  -d '{
  "ValueKind": 1
}'

POST Updated establishment

Description

Updated establishment

URL template
/establishments/updated
Show / Hide additional information

Request Model Example

{
  "ValueKind": 1
}

Response Codes

Status code Description
202 Accepted
400 Invalid event data

Example Request

curl -X POST \
  "https://dev-api.education.gov.uk/testingwebhooks/1/establishments/updated" \
  -H "Content-Type: application/json" \
  -d '{
  "ValueKind": 1
}'

POST Updated group

Description

Updated group

URL template
/governors/updated
Show / Hide additional information

Request Model Example

{
  "ValueKind": 1
}

Response Codes

Status code Description
202 Accepted
400 Invalid event data

Example Request

curl -X POST \
  "https://dev-api.education.gov.uk/testingwebhooks/1/governors/updated" \
  -H "Content-Type: application/json" \
  -d '{
  "ValueKind": 1
}'

POST Updated group

Description

Updated group

URL template
/groups/updated
Show / Hide additional information

Request Model Example

{
  "ValueKind": 1
}

Response Codes

Status code Description
202 Accepted
400 Invalid event data

Example Request

curl -X POST \
  "https://dev-api.education.gov.uk/testingwebhooks/1/groups/updated" \
  -H "Content-Type: application/json" \
  -d '{
  "ValueKind": 1
}'

Back to top