Skip to content

Commit 31c8267

Browse files
chore: add webhook guide link in navbar
Signed-off-by: Akash Kumar <[email protected]>
1 parent 0a3a550 commit 31c8267

File tree

2 files changed

+23
-6
lines changed

2 files changed

+23
-6
lines changed

versioned_docs/version-3.0.0/running-keploy/api-testing-webhook.md

Lines changed: 21 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,28 @@
1+
---
2+
id: api-testing-webhook
3+
title: Webhook Integration
4+
sidebar_label: Webhook Integration
5+
description: Integrate custom logic and external validations into your API testing lifecycle with Keploy's webhooks.
6+
tags:
7+
- API testing
8+
- webhooks
9+
- integration
10+
- custom validation
11+
- policy enforcement
12+
keywords:
13+
- webhook
14+
- API testing
15+
- PreExecute
16+
- PostExecute
17+
- external validation
18+
- custom logic
19+
---
20+
121
## Keploy ATG Webhook Integration Guide
222

323
### 1. Overview
424

5-
Welcome to the Keploy Automated Test Generation (ATG) Webhook system. This powerful feature allows you to integrate your own custom logic directly into the test generation and execution lifecycle.
25+
This powerful feature allows you to integrate your own custom logic directly into the test generation and execution lifecycle.
626

727
You can use webhooks to:
828

@@ -215,10 +235,6 @@ This is the most important rule: **A webhook can make a passing step fail, but i
215235
216236
If Keploy's internal assertions determine a step has failed (e.g., a 500 status code was received when a 200 was expected), the step is permanently failed. Your webhook cannot reverse this decision. This protects the integrity of your test results.
217237

218-
Of course. Since you are not using a separate DTO layer, the documentation must accurately reflect the internal `entModels` that will be serialized directly to JSON. This means exposing all fields as they exist in your Go structs.
219-
220-
Here is the completed "API Reference: Data Structures" section for your documentation, written to be precise and developer-friendly.
221-
222238
### 4. API Reference: Data Structures
223239

224240
Your webhook server will receive an HTTP POST request with a `Content-Type: application/json` header. The body of the request will be a single JSON object, the `WebhookReview`.

versioned_sidebars/version-3.0.0-sidebars.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,8 @@
2424
"running-keploy/share-tests",
2525
"running-keploy/self-healing-ai-api-tests",
2626
"running-keploy/run-ai-generated-api-tests",
27-
"running-keploy/api-testing-cicd"
27+
"running-keploy/api-testing-cicd",
28+
"running-keploy/api-testing-webhook"
2829
]
2930
},
3031
{

0 commit comments

Comments
 (0)