You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Common metadata keys were converted from capitalized names to lowercase with underscores removed (e.g., Message -> message). Verify these match actual payload field names emitted by Gateway to avoid misleading integrators and breaking existing examples.
-`message` (string): a human-readable message from Tyk Gateway that provides details about the event
-`path` (string): the path of the API endpoint request that led to the event being fired
-`origin` (string): origin data for the source of the request (if this exists)
-`key` (string): the key that was used in the request
-`originating_request` (string): a Base64-encoded [raw inbound request]({{< ref "#raw-request-data" >}})
The link to raw request data changed to {{< ref "#raw-request-data" >}}. Confirm the anchor exists on this page after heading text changes to prevent a broken intra-page link.
-`originating_request` (string): a Base64-encoded [raw inbound request]({{< ref "#raw-request-data" >}})
New certificate events list both common and event-specific fields; ensure overlap with common metadata is intentional and examples show a full payload for each event to avoid confusion.
<li>
<details>
<summary>CertificateExpiringSoon</summary>
-`message` (string): a human readable message from Tyk Gateway that adds detail about the event
-`cert_id` (string): the certificate ID
-`cert_name` (string): the name of the certificate
-`expires_at` (string, RFC3339): the certificate expiry date
-`days_remaining` (integer): the remaining days until the certificate expires
-`api_id`(string): the ID of the API that triggered the event
</details>
</li>
<li>
<details>
<summary>CertificateExpired</summary>
-`message` (string): a human readable message from Tyk Gateway that adds detail about the event
-`cert_id` (string): the certificate ID
-`cert_name` (string): the name of the certificate
-`expired_at` (string, RFC3339): the date when the certificate expired
-`days_since_expiry` (integer): the number of days since the certificate expired
-`api_id`(string): the ID of the API that triggered the event
</details>
</li>
</ul>
The anchor reference #raw-request-data may not resolve if the header slug differs or changes. Use a Hugo ref to the canonical section to avoid broken links.
Why: Replacing a bare anchor with a Hugo ref to the canonical section reduces risk of broken links and matches site conventions; the change is accurate for the shown line.
Medium
General
Fix type annotation spacing
Ensure consistent spacing in inline code labels to avoid rendering inconsistencies and potential copy issues. Add a space before the type for api_id.
- `days_remaining` (integer): the remaining days until the certificate expires
-- `api_id`(string): the ID of the API that triggered the event+- `api_id` (string): the ID of the API that triggered the event
Suggestion importance[1-10]: 5
__
Why: This is a minor but valid formatting improvement; adding a space after the key name improves consistency without altering meaning.
Low
Clarify timestamp format
Clarify the exact timestamp format to prevent ambiguity. Specify RFC 3339 format with example or explicitly state timezone (UTC) to avoid misinterpretation.
-- `expired_at` (string, RFC3339): the date when the certificate expired+- `expired_at` (string, RFC3339, UTC): the date and time when the certificate expired (for example, 2025-01-15T13:45:30Z)
Suggestion importance[1-10]: 4
__
Why: Adding UTC and an example can help readers, but it’s optional editorial guidance rather than a correctness fix; ensure consistency with docs style before adopting.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
User description
…6960)
Contributor checklist
New Contributors
masterPR Type
Documentation
Description
Add certificate expiry event docs
Detail event-specific metadata fields
Clarify common event metadata format
Minor formatting cleanups in notes
Diagram Walkthrough
File Walkthrough
gateway-events.md
Add certificate expiry events and metadata detailstyk-docs/content/api-management/gateway-events.md
CertificateExpiringSoon,CertificateExpired.