Skip to content

3.3. Webhook

Alex Alves edited this page Mar 5, 2021 · 2 revisions

When the generate coverage processing to end, the custom task will call an API, if the Webhook field is filled, and will pass some data of the coverage generated. The payload model that will be generated is:

VERB: POST

{
	"application": "string",
	"apiTested": "string",
	"createAt": "date",
	"buildNumber": "string",
	"totalEndpointsFound": "number",
	"totalEndpointsTested": "number",
	"coverage": "number",
	"endpointsFound": [{
		"path": "string",
		"infoPath": [{
			"verb": "string",
			"time": "number",
			"executeAt": "Date",
			"success": "string"
		}]
	}],
	"endpointsTested": [{
		"path": "string",
		"infoPath": [{
			"verb": "string",
			"time": "string",
			"executeAt": "Date",
			"success": "boolean",
			"failureMessage": "string"
		}]
	}],
	"endpointsUncover": [{
		"path": "string",
		"infoPath": [{
			"verb": "string",
			"time": "number",
			"executeAt": "Date",
			"success": "boolean"
		}]
	}],
	"totalTime": "number",
	"totalSucceed": "number",
	"totalFailure": "number"
}
Clone this wiki locally