Statuscake | Composio Docs

Overview

SLUG: STATUSCAKE

Description

Template description for Statuscake

Authentication Details

API Key

api_key

stringRequired

Connecting to Statuscake

Create an auth config

Use the dashboard to create an auth config for the Statuscake toolkit. This allows you to connect multiple Statuscake accounts to Composio for agents to use.

Select App

Navigate to Statuscake.

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

Create and Get auth config ID

Click “Create Statuscake Auth Config”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using API Key

1 from composio import Composio
2 
3 # Replace these with your actual values
4 statuscake_auth_config_id = "ac_YOUR_STATUSCAKE_CONFIG_ID" # Auth config ID created above
5 user_id = "0000-0000-0000"  # UUID from database/app
6 
7 composio = Composio()
8 
9 def authenticate_toolkit(user_id: str, auth_config_id: str):
10     # Replace this with a method to retrieve an API key from the user.
11     # Or supply your own.
12     user_api_key = input("[!] Enter API key")
13 
14     connection_request = composio.connected_accounts.initiate(
15         user_id=user_id,
16         auth_config_id=auth_config_id,
17         config={"auth_scheme": "API_KEY", "val": {"generic_api_key": user_api_key}}
18     )
19 
20     # API Key authentication is immediate - no redirect needed
21     print(f"Successfully connected Statuscake for user {user_id}")
22     print(f"Connection status: {connection_request.status}")
23     
24     return connection_request.id
25 
26 
27 connection_id = authenticate_toolkit(user_id, statuscake_auth_config_id)
28 
29 # You can verify the connection using:
30 connected_account = composio.connected_accounts.get(connection_id)
31 print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the Statuscake toolkit’s playground

OpenAI (Python)

Anthropic (TypeScript)

Google (Python)

Vercel (TypeScript)

Python

1 from composio import Composio
2 from openai import OpenAI
3 import json
4 
5 openai = OpenAI()
6 composio = Composio()
7 
8 # User ID must be a valid UUID format
9 user_id = "0000-0000-0000"  # Replace with actual user UUID from your database
10 
11 tools = composio.tools.get(user_id=user_id, toolkits=["STATUSCAKE"])
12 
13 print("[!] Tools:")
14 print(json.dumps(tools))
15 
16 def invoke_llm(task = "What can you do?"):
17     completion = openai.chat.completions.create(
18         model="gpt-4o",
19         messages=[
20             {
21                 "role": "user",
22                 "content": task,  # Your task here!
23             },
24         ],
25         tools=tools,
26     )
27 
28     # Handle Result from tool call
29     result = composio.provider.handle_tool_calls(user_id=user_id, response=completion)
30     print(f"[!] Completion: {completion}")
31     print(f"[!] Tool call result: {result}")
32 
33 invoke_llm()

Tool List

STATUSCAKE_DELETE_CONTACT_GROUP

Tool Name: Delete Contact Group

Description

Tool to delete a contact group. use when you need to remove an existing contact group by its id after confirming its existence.

Action Parameters

contact_group_id

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

STATUSCAKE_DELETE_TEST

Tool Name: Delete Test

Description

Tool to delete a statuscake test. use when you need to remove a test by its id after it's no longer needed.

Action Parameters

test_id

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

STATUSCAKE_GET_ALL_CONTACT_GROUPS

Tool Name: Get All Contact Groups

Description

Tool to retrieve all contact groups. use when you need to list existing contact groups in statuscake after authenticating.

Action Parameters

limit

integer

page

integer

string

Action Response

data

arrayRequired

error

string

metadata

objectRequired

successful

booleanRequired

STATUSCAKE_GET_ALL_LOCATIONS

Tool Name: Get All Monitoring Locations

Description

Tool to retrieve a list of all monitoring locations. use when you need to display or choose from available statuscake locations.

Action Parameters

Action Response

data

arrayRequired

error

string

successful

booleanRequired

STATUSCAKE_GET_ALL_PAGESPEED_TESTS

Tool Name: Get All PageSpeed Tests

Description

Tool to retrieve all pagespeed tests. use when you need to list existing pagespeed performance tests in statuscake after authenticating.

Action Parameters

page

integer

page_size

integer

Action Response

data

arrayRequired

error

string

metadata

objectRequired

successful

booleanRequired

STATUSCAKE_GET_ALL_TESTS

Tool Name: Get All Tests

Description

Tool to retrieve a list of all tests. use when you need to list your monitoring tests in statuscake.

Action Parameters

limit

integer

page

integer

STATUSCAKE_GET_HEARTBEAT_CHECKS

Tool Name: Get Heartbeat Checks

Description

Tool to list heartbeat checks. use when you need to retrieve all heartbeat monitoring tests for your account.

Action Parameters

page

integer

per_page

integer

Action Response

data

arrayRequired

error

string

metadata

objectRequired

successful

booleanRequired

STATUSCAKE_GET_SSL_CHECKS

Tool Name: Get SSL Checks

Description

Tool to retrieve a list of ssl checks. use when you need to list all ssl tests for your account.

Action Parameters

limit

integer

offset

integer

string

status

string

STATUSCAKE_UPDATE_CONTACT_GROUP

Tool Name: Update Contact Group

Description

Tool to update an existing contact group. use when you have the contact group id and want to change its configuration.

Action Parameters

contact_group_id

stringRequired

emails

array

integration_ids

array

name

stringRequired

push_notifications

boolean

sms

array

webhook_urls

array

Action Response

data

objectRequired

error

string

metadata

objectRequired

successful

booleanRequired

STATUSCAKE_GET_CONTACT_GROUP_DETAILS

Tool Name: Get Contact Group Details

Description

Tool to retrieve details of a specific contact group. use when you need group metadata by providing its id. example: "get details for contact group 12345".

Action Parameters

contact_group_id

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

STATUSCAKE_GET_SSL_CHECK_DETAILS

Tool Name: Get SSL Check Details

Description

Tool to retrieve details of a specific ssl check. use when you need configuration and status of an ssl test by providing its id. example: "get ssl check details for 123".

Action Parameters

test_id

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired