Skip to main content
Codemagic logo
  • Category: developer tools
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 22
  • Triggers: 0
  • Slug: CODEMAGIC
  • Version: 20261101_00

Tools

Slug: CODEMAGIC_ADD_APPLICATION_FROM_PRIVATE_REPOTool to create an application from a private repository using SSH key authentication. Use when you need to add a new private repository to Codemagic with SSH credentials.

Input Parameters

object
required
SSH key credentials required to access the private repository.
string
Team ID for direct app addition to a team. Requires admin privileges for the specified team.
string
Specify ‘flutter-app’ when adding Flutter applications. Omit for other project types.
string
required
SSH or HTTPS URL for cloning the private repository. For SSH URLs, use format: git@github.com:org/repo.git

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODEMAGIC_ADD_NEW_APPLICATIONTool to add a Git repository to the applications list in Codemagic. Use when you need to add a new application to Codemagic from a repository URL.

Input Parameters

string
Team ID, if you wish to add an app directly to one of your teams. You must be an admin in the team specified.
string
required
SSH or HTTPS URL for cloning the repository.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODEMAGIC_API_V3_META_GET_METATool to get metadata about Codemagic including public IP addresses in use (in CIDR notation). Use when you need to retrieve IP blocks for whitelisting build machines or simulator network requests.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODEMAGIC_API_V3_VARIABLE_GROUPS_VARIABLE_GROUP_ID_GET_GROUPTool to retrieve information about a specific variable group including its name and configuration settings. Use when you need to get details for a variable group by its ID.

Input Parameters

string
required
The unique identifier for the variable group in MongoDB ObjectId format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODEMAGIC_API_V3_VARIABLE_GROUPS_VARIABLE_GROUP_ID_UPDATETool to change a variable group’s name and security settings. Use when you need to update an existing variable group by its ID. Returns success confirmation on 204 No Content response.

Input Parameters

string
The new name for the variable group.
object
Advanced security configuration for a variable group.
string
required
The unique identifier for the variable group in MongoDB ObjectId format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODEMAGIC_DELETE_ALL_APPLICATION_CACHESTool to delete all caches for a specific application. Use when clearing all cached data for an app. The deletion process is asynchronous and will complete after the API response is returned.

Input Parameters

string
required
The application identifier

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODEMAGIC_DELETE_SPECIFIC_CACHEDelete a specific cache from an application.

Input Parameters

string
required
The application identifier
string
required
The cache identifier to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODEMAGIC_GET_ALL_BUILDSTool to list all builds with optional filters for appId, workflowId, and branch. Use when you need to retrieve build history or search for specific builds. Supports pagination via the skip parameter.

Input Parameters

integer
Pagination offset for skipping results
string
Filter builds by application ID
string
Filter builds by git branch name
string
Filter builds by workflow ID. May return null for YAML-based workflows.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODEMAGIC_GET_API_KEYTool to retrieve the API key for the authenticated user from the server. Use when you need to fetch the API key via the Codemagic API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODEMAGIC_GET_SHOREBIRD_METATool to retrieve information about Shorebird integration. Use when you need to check supported Flutter versions or the current Shorebird version.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODEMAGIC_GET_USERTool to retrieve information about the currently authenticated user. Use when you need to get user ID, avatar URL, or check user permissions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODEMAGIC_GET_VARIABLE_GROUPSTool to retrieve paginated list of variable groups for an application. Use when you need to list or browse variable groups associated with a specific app.

Input Parameters

integer
The page number of the results to fetch. Minimum: 1, Default: 1.
string
required
The unique identifier for the application.
integer
The maximum number of results per page. Range: 1-100, Default: 30.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODEMAGIC_GET_VARIABLESTool to retrieve paginated list of variables for a specific variable group. Use when you need to list or browse environment variables within a variable group.

Input Parameters

integer
The page number of the results to fetch. Minimum: 1, Default: 1.
Search query to filter variables.
integer
The maximum number of results per page. Range: 1-100, Default: 30.
string
required
The identifier for the variable group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODEMAGIC_INVITE_TEAM_MEMBERTool to invite a new team member to a Codemagic team. Use when you need to grant team access to a user. Requires team admin privileges. The ‘developer’ role corresponds to Member role and ‘owner’ role corresponds to Admin role in Codemagic UI.

Input Parameters

string ("developer" | "owner")
required
The role to assign to the invited user. ‘developer’ corresponds to Member role in UI, ‘owner’ corresponds to Admin role in UI
string
required
The email address of the user to invite
string
required
The unique identifier of the team to invite the member to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODEMAGIC_RECEIVE_WEBHOOKSend a webhook payload for a specified Codemagic application to trigger builds from repository events. The payload includes a Git reference, repository and pusher information, and optional additional event data.

Input Parameters

string
required
Git reference (branch or tag) that triggered the webhook. Format: refs/heads/{branch} or refs/tags/{tag}
string
required
The application identifier for which to trigger the webhook. Found in the Codemagic browser URL after ‘app/’ when viewing your application.
object
required
Information about the user who triggered the webhook
object
required
Repository information containing the clone URL
object
Additional webhook payload data from the Git provider. This can contain provider-specific fields like commits, pull_request, etc.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODEMAGIC_REMOVE_TEAM_MEMBERTool to remove a collaborator or revoke a pending invitation from a Codemagic team. Use when you need to revoke team access for a specific user or cancel a pending invitation. Supports both active members (MongoDB-style IDs) and pending invitations (UUID-style invitation codes).

Input Parameters

string
required
The unique identifier of the team
string
required
The unique identifier of the user/collaborator to be removed, or the invitation code for pending invitations. Active members have MongoDB-style IDs (24 hex characters), while pending invitations have UUID-style IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODEMAGIC_RETRIEVE_ALL_APPLICATIONSTool to retrieve all applications added to Codemagic. Use when you need to list or browse all applications in the Codemagic account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODEMAGIC_RETRIEVE_AN_APPLICATIONTool to retrieve a single application by its unique identifier. Use when you need to get application details including name, branches, and workflow configuration.

Input Parameters

string
required
The unique identifier for the application.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODEMAGIC_RETRIEVE_CACHES_FOR_APPLICATIONTool to retrieve a list of caches for a specific application. Use when you need to view cached data, check cache sizes, or manage application storage.

Input Parameters

string
required
The application identifier - unique ID of the application whose caches you want to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODEMAGIC_START_NEW_BUILDTool to start a new build for an application with specified workflow and branch or tag. Use when you need to trigger a build programmatically. Either branch or tag parameter must be provided.

Input Parameters

string
Git tag name to build. Either branch or tag must be provided.
string
required
The application identifier
string
Git branch name to build. Either branch or tag must be provided.
array
Additional labels to attach to the build
object
Overrides for environment variables, variable groups, and software versions
string
required
The workflow identifier as specified in the YAML file
string
Machine type for build execution

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODEMAGIC_STOP_PREVIEWTool to stop an app preview. Use when you need to stop a running app preview by its identifier.

Input Parameters

string
required
The preview identifier to stop

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CODEMAGIC_UPDATE_VARIABLETool to update an existing variable within a specified variable group in Codemagic. Use when you need to modify a variable’s name, value, or secure status.

Input Parameters

string
The variable’s name. Provide this if you want to update the variable name.
string
The variable’s value. Provide this if you want to update the variable value.
boolean
Whether the variable should be treated as secure (encrypted). Provide this if you want to change the secure status.
string
required
The identifier for the variable to be updated.
string
required
The identifier for the variable group containing the variable.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not