Skip to content

Fill gaps from assistant conversations: env var encoding and JSM webhook #481

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mintlify wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fill gaps from assistant conversations: env var encoding and JSM webhook #481

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions detect/synthetic-monitoring/api-checks/configuration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,12 @@ Variables can be used in the following API checks fields:
- Query parameters values
- Basic authentication username and password

#### Preserving special characters with triple brackets

Double-bracket references are encoded before the request is sent. Characters such as `&`, `<`, `>`, `"`, and `'` are replaced with their encoded equivalents (for example, `&` becomes `&amp;`). This can break header values, API keys, and tokens that must be sent verbatim.

Use triple brackets when the raw value must reach the target server unchanged. For example, if the value of an `X-API-Key` header stored in `USER_API_KEY` contains an ampersand, reference it as `{{{USER_API_KEY}}}` in the header value so the ampersand is not encoded.

### Using helpers and built-in variables

Next to your own variables, we've added some built-in ones.
Expand Down
4 changes: 3 additions & 1 deletion integrations/alerts/webhooks.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -268,7 +268,9 @@ This means that for checks on a 1 minute schedule, there is a potential overlap

The following examples give an idea how to integrate Checkly with 3rd party alerting and issue tracking systems.

### OpsGenie
### OpsGenie and Jira Service Management (JSM) Operations

Checkly does not ship a dedicated JSM Operations alert channel. Because JSM Operations is built on the OpsGenie alerts API, the same webhook pattern shown below works for both. Point the webhook URL at your JSM Operations alerts endpoint instead of the OpsGenie one, keep the payload as-is, and authenticate with the API key issued by JSM.

You can create an <a href="https://docs.opsgenie.com/docs/alert-api" target="_blank">OpsGenie</a>

Expand Down
Loading