API Keys & Campaign ID

Welcomessage authenticates all requests from the REST API using both your team's API Key and a specific Campaign ID. Each API request must include a valid API key to ensure successful authentication.

Obtaining API Keys

You can find the API keys for your team under the API Key section of your Team Settings in the dashboard.

Obtaining Campaign IDs

You can find the Campaign ID under the API Key section of your Campaign Settings in the dashboard.

Keeping API Keys Secure

API keys grant access to perform API actions on behalf of your Welcomessage account, including sending messages and managing campaigns. It's crucial to keep these keys secure and never expose them to public areas such as GitHub repositories, client-side code, or any other publicly accessible locations.

Here are some best practices for securing your API keys:

• Store them in a secure server-side environment.

• Avoid embedding API keys in client-side code.

• Use environment variables to manage sensitive information.

Adding and Revoking API Keys

You can create as many API keys as your team requires. If an API key becomes compromised or is no longer needed, you can revoke it instantly:

1. Go to the Team Settings under the API Key section.

2. Select the API key you wish to revoke and click the revoke button.

   • Once revoked, the API key will immediately become invalid and can no longer be used for any API requests.