Important

• An API key gives access to your Twikey environment. Handle it with care !
• Only provide the key to trusted systems and personnel. You can grant them access as an admin user.

Create a new API key

1. Navigate to Settings in your Twikey menu.
2. Navigate to API
3. Click New

Configure your API key

You can now configure the following settings :

• Base URL: The base endpoint URL used for API requests.
• Description: Add a meaningful description for your key (e.g., “Accounting Integration”).
• Administrator: Select the user responsible for this key. All API requests will be logged under this user.
• Use enhanced security: Creates a secondary token for calculating a 2FA code. Recommended only for advanced users. (Optional)
• Scope: Select which type of webhooks you would like to receive for this key. Read about webhooks on our API documentation.
• Webhook URL: Enter the HTTPS URL where incoming webhooks should be sent. (HTTPS required).

Click Save to finish the configuration and create the API key.