ClickUp

Overview

This document provides a detailed guide to integrating ClickUp with Callgoose SQIBS for real-time Incident Management, Task Tracking, Event-Driven Automation, and other automation purposes. The integration enables automatic creation, updating, and resolution of incidents or tasks in Callgoose SQIBS based on updates or changes in ClickUp. The guide includes steps for setting up webhooks in ClickUp, configuring the necessary API filters in Callgoose SQIBS, and troubleshooting.

Prerequisites

• ClickUp Account: Access to ClickUp with permissions to manage webhooks.
• Callgoose SQIBS Account: With valid privileges to set up API filters and receive notifications.
• Webhook/API Endpoint: Available in Callgoose SQIBS to receive alerts from ClickUp.

1. Obtain API Token and Endpoint Details

To integrate with Callgoose SQIBS, you first need to obtain an API token and find the API endpoint details.

1. Generate an API Token:

• Follow the guide on How to Create API Token in Callgoose SQIBS.

1. Find the API Endpoint:

• Refer to the Callgoose SQIBS API Endpoint Documentation to get the endpoint details where the JSON payloads from ClickUp will be sent.

2. Debugging and Troubleshooting

You can enable debugging in the API tokens used with ClickUp notifications for troubleshooting purposes.

• Enable Debugging:
• You can update the debug value when adding or updating an API token.
• When API tracking is enabled, logs are stored in the API log section for your review. The debugging option will automatically disable after 48 hours.
• When API tracking is turned off, no logs are saved in the API log.
• Using API Log for Troubleshooting:
• The API log provides detailed information on all API calls made to Callgoose SQIBS.
• You can check the JSON values in each API log entry for troubleshooting purposes.
• Use the information in the API log to create or refine API filters to ensure incidents are created correctly based on the API payloads received.
• Callgoose SQIBS creates incidents according to your API filter configuration, giving you full control over how alerts from different services trigger incidents and alerts for your support team or automation processes.

3. Configuring ClickUp to Send JSON Payloads

To configure ClickUp to generate the JSON payloads similar to the examples provided, follow the steps outlined below. These steps will guide you through setting up the necessary webhooks within ClickUp to ensure that the JSON payloads match those expected by Callgoose SQIBS.

3.1 Setting Up Webhooks in ClickUp

To generate the required JSON payloads, you first need to set up webhooks within ClickUp.

1. Log in to the ClickUp Console:

• Access the ClickUp platform using your account credentials.

1. Navigate to Webhooks Section:

• In the ClickUp console, go to Settings > Webhooks.

1. Create a New Webhook:

• Click on Add Webhook to create a new webhook.
• Specify Trigger Events: Define the events that will trigger the webhook, such as task creation, task updates, or status changes.

1. Configure the Webhook URL:

• Choose Webhook as the notification method to send data to a webhook.
• Webhook URL: Enter the webhook URL provided by Callgoose SQIBS.

3.2 Configuring the Webhook Notification

To ensure that the JSON payload sent matches the examples provided, follow these steps when configuring the webhook:

1. Add Webhook URL:

• In the Webhook URL field, enter the endpoint provided by Callgoose SQIBS.
• Ensure the protocol is HTTPS for secure data transmission.

1. Customize Payload Format:

• Ensure that the payload includes key fields like "status", "event", "severity", "description", "timestamp", and others as shown in the example payloads.

1. Test the Webhook Configuration:

• Before activating the webhook, perform a test to ensure that the JSON payload is correctly formatted and is being sent to the Callgoose SQIBS API endpoint as expected.
• Review the payload in Callgoose SQIBS to confirm that it matches the expected structure.

4. Configuring Callgoose SQIBS

4.1 Create API Filters in Callgoose SQIBS

To correctly map incidents from the ClickUp alerts, you need to create API filters based on the JSON payloads received.

4.1.1 Example JSON Payloads from ClickUp

Task Created (status: "Open")

json

{
  "task": {
    "id": "task123",
    "name": "New Task Created",
    "status": "Open",
    "description": "A new task has been created",
    "due_date": "2024-08-05T12:00:00.000Z",
    "assignee": "user@example.com",
    "timestamp": "2024-08-05T12:00:00.000Z"
  }
}

Task Closed (status: "Closed")

json

{
  "task": {
    "id": "task123",
    "name": "New Task Created",
    "status": "Closed",
    "description": "Task has been completed",
    "due_date": "2024-08-05T12:00:00.000Z",
    "assignee": "user@example.com",
    "timestamp": "2024-08-05T12:30:00.000Z"
  }
}

4.2 Configuring API Filters

4.2.1 Integration Templates

If you see a ClickUp integration template in the "Select Integration Template" dropdown in the API filter settings, you can use it to automatically add the necessary Trigger and Resolve filters along with other values. The values added by the template can be modified to customize the integration according to your requirements.

4.2.2 Manually Add/Edit the Filter

• Trigger Filter (For Creating Incidents):
• Payload JSON Key: "status"
• Key Value Contains: [Open, In Progress]
• Map Incident With: "task.id"
• This corresponds to the unique task.id from the ClickUp payload.
• Incident Title From: "task.name"
• This will use the task name as the incident title in Callgoose SQIBS.
• Incident Description From: Leave this empty unless you want to use a specific key-value from the JSON payload. If a key is entered, only the value for that key will be used as the Incident Description instead of the full JSON. By default, the Incident Description will include the full JSON values.
• Resolve Filter (For Resolving Incidents):
• Payload JSON Key: "status"
• Key Value Contains: [Closed]
• Incident Mapped With: "task.id"
• This ensures the incident tied to the specific task.id is resolved when the task status changes to Closed.

Refer to the API Filter Instructions and FAQ for more details.

4.3 Finalizing Setup

1. Save the API Filters:

• Ensure that the filters are correctly configured and saved in Callgoose SQIBS.
• Double-check that all key mappings, incident titles, and descriptions are correctly aligned with the payload structure sent by ClickUp.

1. Test the Integration:

• Manually trigger an event in ClickUp (e.g., create or close a task) to test if incidents are created in Callgoose SQIBS.
• Verify that the incident appears in Callgoose SQIBS with the correct title, description, and mapped values.
• Resolve the task in ClickUp and ensure that the corresponding incident in Callgoose SQIBS is marked as resolved.

5. Testing and Validation

5.1 Triggering Alerts

• Simulate Task Creation:
• Create a task in ClickUp to simulate an alert condition.
• Verify that an incident is created in Callgoose SQIBS with the correct information.

5.2 Resolving Alerts

• Complete the Task:
• Mark the task as completed in ClickUp to simulate the resolution of an alert.
• Verify that the incident in Callgoose SQIBS is automatically marked as resolved.

6. Security Considerations

• API Security: Ensure that the Callgoose SQIBS API endpoint is correctly configured and that the API token is securely stored and used.
• ClickUp Permissions: Confirm that the webhook in ClickUp has appropriate permissions to send alerts and data to Callgoose SQIBS.
• Data Encryption: Ensure that the transmission of data between ClickUp and Callgoose SQIBS is encrypted, especially if sensitive information is involved.
• Access Control: Implement strong access controls and monitor who has access to both ClickUp and Callgoose SQIBS to prevent unauthorized changes or access.

7. Troubleshooting

• No Incident Created: If no incident is created, verify that the webhook URL in ClickUp is correct and that the JSON payload structure matches the API filters configured in Callgoose SQIBS. Also, ensure that the webhook is active and that the correct events are selected for triggering the webhook.
• Incident Not Resolved: If the incident in Callgoose SQIBS is not marked as resolved when the task is closed in ClickUp, check that the resolve filter in Callgoose SQIBS is correctly configured. Ensure that the "status" field in the JSON payload is correctly mapped and that the payload contains the expected values for a resolved state.
• Payload Structure Mismatch: If there are discrepancies in the JSON payload structure, you may need to adjust the webhook settings in ClickUp to ensure the payload matches the expected format in Callgoose SQIBS. Use the API log in Callgoose SQIBS to review the received payloads and make necessary adjustments.
• Debugging API Calls: Enable debugging in the API token settings in Callgoose SQIBS to track incoming API calls and diagnose issues with the integration. The API logs will provide detailed information about the payloads received and any errors encountered during processing.
• Authentication Issues: If the webhook is not able to authenticate with Callgoose SQIBS, ensure that the correct API token is being used and that it has the necessary permissions. Check for any changes in the token or endpoint URL and update them if necessary.

8. Conclusion

This guide provides a comprehensive overview of how to integrate ClickUp with Callgoose SQIBS for effective incident management and task tracking. By following the steps outlined, you can ensure that updates from ClickUp are automatically reflected as incidents in Callgoose SQIBS, with proper resolution tracking when the tasks are completed or updated.

For further customization or advanced use cases, refer to the official documentation for both ClickUp and Callgoose SQIBS:

• ClickUp Documentation
• Callgoose SQIBS API Token Documentation
• Callgoose SQIBS API Endpoint Documentation
• API Filter Instructions and FAQ
• How to Send API

This documentation will guide you through the integration process, ensuring that your incidents and tasks are managed effectively within Callgoose SQIBS based on real-time updates from ClickUp.