scalenowAI

API and Webhooks

API and Webhooks

Enhance scalenow AI environment by configuring API settings and managing webhooks for seamless integration with external applications.

API Management

To configure API settings in scalenow AI, navigate to Administration → API and Webhooks.

API Settings

Manage your REST API settings to control access by external applications and streamline integration:

  • Access Control: Enable or restrict access to API endpoints for external applications using API tokens created via the user’s Account Settings page.
  • Page Size Limit: Define the maximum number of results returned per page by the API. Requests exceeding this limit will be denied.
  • Write Access to Read-Only Attributes: Allow administrators to write to static read-only attributes (e.g., createdAt and author) during record creation.

You need to have administrative rights to access these services

 

API Documentation

API Documentation

If enabled, access an interactive APIv3 documentation page under [baseURL]/api/docs. This page provides comprehensive details on API endpoints and usage.

Cross-Origin Resource Sharing (CORS)

Enable CORS to allow specific external origins to access authenticated API resources:

  • Configuration: Check the CORS box to activate the headers for APIv3 and dependent authentication endpoints, such as /oauth/token.
  • Allowed Origins: Specify permissible values for the Origin header to ensure secure access. Avoid using the *wildcard for authenticated resources.
  • Additional Resources: Learn more about CORS:
    • CORS Overview (MDN)
    • CORS Tutorial (Auth0)

You need to have administrative rights to access these services

Webhook Integration

Webhooks enable automated interactions between scalenow AI  and external systems, such as triggering billing applications when a time log is created.

Creating a Webhook

  1. Add a Webhook: Click the green + Webhook button in the Webhooks section of the Administration menu.
  2. Configure Webhook Options:
    • Name: Assign a descriptive name for the webhook.
    • Payload URL: Specify the endpoint to receive webhook requests.
    • Description: Add optional details about the webhook’s purpose.
    • Signature Secret: Define a secret key to verify that requests originate from scalenow AI.
    • Status: Activate or deactivate the webhook.
    • Trigger Events: Choose events to trigger the webhook (e.g., project updates, work package creation, or time entry creation).
    • Project Scope: Select whether the webhook applies to all projects or specific ones. For instance, if you specify “System Admin Guide,” the webhook will only activate for actions within that project.
  3. Save Changes: Click the orange Create button to finalize the webhook. Use the Cancel button if needed.

By configuring these features, you can enhance the integration capabilities of scalenow AI while maintaining control over API and webhook functionality.

You need to have administrative rights to access these services