API Client libraries

Tests

The tests run against the preview environment. The easiest way to check any work done on them is by using the same environment variables as preview.

Environment variables

The environment variables used by preview are kept in the 'client-integration-tests' credentials store.

Assuming you have the notify-pass credentials store set up, run this command to see them:

notify-pass show credentials/client-integration-tests

Templates

The templates used by the tests are part of the 'Client Integration Tests' service on the preview environment. You can see them at https://www.notify.works.

Documentation

Technical documentation for our API client libraries lives in the tech-docs repo.

When writing and updating documentation for our API client libraries, please do so in line with Code snippets style guide.