Tyk Webhooks API
Webhooks are a great way to let external applications know about the status of a user, an API or an event that has occurred in the Tyk gateway You can create webhooks that you can then re-use in your API definitions and assign to different Tyk Events such as quota violations or rate-limiting violations.Each webhook require a target_path (which is an absolute URL that should be targeted by the webhook e.g https://httpbin.org/expired-keys) and a method which can be any of GET, PUT, POST, PATCH or DELETE.Request types that do not support an encoded body will not have the event metadata encoded as part of the request. We would advise using POST where possible.
Tyk Webhooks API is one of 39 APIs that Tyk publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 1 JSON Schema definition.
Tagged areas include Webhook. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, a GitHub repository, a changelog, and 1 JSON Schema.
This API exposes 5 operations across 2 paths, and defines 4 schemas. It is described by OpenAPI 3.2.0, at version 5.7.1.
Requests are made against a single base URL, https://{tenant}.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Tyk Webhooks API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (bearerAuth).
By default, every request must be authenticated.
bearerAuth— The Tyk Dashboard API Access Credentials
Paths & Operations 5
Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Webhooks are a great way to let external applications know about the status of a user, an API or an event that has occurred in the Tyk gateway You can create webhooks that you can…
Schemas 4
The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are WebHookHandlerConf (10 properties), ApiResponse (4 properties), WebHooks (2 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Tyk 12
Other APIs Tyk publishes across the network.
This is an independent, third-party profile of Tyk Webhooks API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.