Codemagic

codemagic

Codemagic is a CI/CD platform focused on mobile app development.

Developer Tools Web del proveedor

Acciones

Triggers

Autenticación

—

OAuth gestionado

Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (23)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

Add Application from Private RepositoryCODEMAGIC_ADD_APPLICATION_FROM_PRIVATE_REPOAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Add New ApplicationCODEMAGIC_ADD_NEW_APPLICATIONAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Meta InformationCODEMAGIC_API_V3_META_GET_METAAcción

Tool 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.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Metadata about Codemagic including public IP addresses.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Variable Group InformationCODEMAGIC_API_V3_VARIABLE_GROUPS_VARIABLE_GROUP_ID_GET_GROUPAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Variable group information including name and security settings.
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Variable GroupCODEMAGIC_API_V3_VARIABLE_GROUPS_VARIABLE_GROUP_ID_UPDATE_GROUPAcción

Tool 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.

Parámetros de entrada

namestring
The new name for the variable group.
advanced_securityobject
Advanced security configuration for a variable group.
variable_group_idstringObligatorio
The unique identifier for the variable group in MongoDB ObjectId format.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete All Application CachesCODEMAGIC_DELETE_ALL_APPLICATION_CACHESAcción

Tool 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.

Parámetros de entrada

idstringObligatorio
The application identifier

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete Specific CacheCODEMAGIC_DELETE_SPECIFIC_CACHEAcción

Tool to delete a specific cache from an application. Use when a cached build artifact needs to be removed. The deletion is performed asynchronously and returns immediately with a 202 Accepted status.

Parámetros de entrada

app_idstringObligatorio
The application identifier
cache_idstringObligatorio
The cache identifier to delete

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Account Info for Over-the-Air UpdatesCODEMAGIC_GET_ACCOUNT_INFOAcción

Tool to retrieve account information for over-the-air updates. Use when you need to check the account status (enabled/disabled/pending) and associated team identifier.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Account information for over-the-air updates
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get All BuildsCODEMAGIC_GET_ALL_BUILDSAcción

Tool 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.

Parámetros de entrada

skipinteger
Pagination offset for skipping results
app_idstring
Filter builds by application ID
branchstring
Filter builds by git branch name
workflow_idstring
Filter builds by workflow ID. May return null for YAML-based workflows.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get API KeyCODEMAGIC_GET_API_KEYAcción

Tool to retrieve the API key for the authenticated user. Use when you need to fetch the API key associated with the current authentication token.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Authenticated UserCODEMAGIC_GET_USERAcción

Tool to retrieve information about the currently authenticated user. Use when you need to get user ID, avatar URL, or check user permissions.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Variable Groups for AppCODEMAGIC_GET_VARIABLE_GROUPSAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobject[]Obligatorio
Array of variable group objects.
errorstring
Error if any occurred during the execution of the action
page_sizeintegerObligatorio
Results per page (max 100, min 1, default 30).
successfulbooleanObligatorio
Whether or not the action execution was successful or not
total_pagesintegerObligatorio
Total available pages.
current_pageintegerObligatorio
Current page number (min 1, default 1).

List Variables for GroupCODEMAGIC_GET_VARIABLESAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobject[]Obligatorio
Array of environment variable objects.
errorstring
Error if any occurred during the execution of the action
page_sizeintegerObligatorio
Number of items per page.
successfulbooleanObligatorio
Whether or not the action execution was successful or not
total_pagesintegerObligatorio
Total number of pages available.
current_pageintegerObligatorio
Current page number.

Invite Team MemberCODEMAGIC_INVITE_TEAM_MEMBERAcción

Tool 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.

Parámetros de entrada

rolestringObligatorioenum
The role to assign to the invited user. 'developer' corresponds to Member role in UI, 'owner' corresponds to Admin role in UI
developerowner
emailstringObligatorio
The email address of the user to invite
team_idstringObligatorio
The unique identifier of the team to invite the member to

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Team AppsCODEMAGIC_LIST_TEAM_APPSAcción

Tool to list all apps for a specific team in Codemagic. Use when you need to browse or retrieve team application information. Supports pagination via page and page_size parameters.

Parámetros de entrada

pageinteger
The page number of the results to fetch. Default: 1, Minimum: 1
team_idstringObligatorio
The identifier for the team.
page_sizeinteger
The maximum number of results per page. Default: 30, Range: 1-100

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Receive WebhookCODEMAGIC_RECEIVE_WEBHOOKAcción

Tool to receive webhook payloads from Git providers to trigger builds automatically. Use when repository events (commits, pull requests, tags) need to trigger Codemagic builds programmatically.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Remove Team MemberCODEMAGIC_REMOVE_TEAM_MEMBERAcción

Tool to remove a collaborator from a Codemagic team. Use when you need to revoke team access for a specific user. The removal is performed asynchronously and returns immediately with a 202 Accepted status.

Parámetros de entrada

team_idstringObligatorio
The unique identifier of the team
user_idstringObligatorio
The unique identifier of the user/collaborator to be removed

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve All ApplicationsCODEMAGIC_RETRIEVE_ALL_APPLICATIONSAcción

Tool to retrieve all applications added to Codemagic. Use when you need to list or browse all applications in the Codemagic account.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve an ApplicationCODEMAGIC_RETRIEVE_AN_APPLICATIONAcción

Tool to retrieve a single application by its unique identifier. Use when you need to get application details including name, branches, and workflow configuration.

Parámetros de entrada

idstringObligatorio
The unique identifier for the application.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve Caches for ApplicationCODEMAGIC_RETRIEVE_CACHES_FOR_APPLICATIONAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Start New BuildCODEMAGIC_START_NEW_BUILDAcción

Tool 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.

Parámetros de entrada

tagstring
Git tag name to build. Either branch or tag must be provided.
app_idstringObligatorio
The application identifier
branchstring
Git branch name to build. Either branch or tag must be provided.
labelsstring[]
Additional labels to attach to the build
environmentobject
Overrides for environment variables, variable groups, and software versions
workflow_idstringObligatorio
The workflow identifier as specified in the YAML file
instance_typestring
Machine type for build execution

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Stop PreviewCODEMAGIC_STOP_PREVIEWAcción

Tool to stop an app preview. Use when you need to stop a running app preview by its identifier.

Parámetros de entrada

preview_idstringObligatorio
The preview identifier to stop

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Variable in GroupCODEMAGIC_UPDATE_VARIABLEAcción

Tool 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.

Parámetros de entrada

namestring
The variable's name. Provide this if you want to update the variable name.
valuestring
The variable's value. Provide this if you want to update the variable value.
secureboolean
Whether the variable should be treated as secure (encrypted). Provide this if you want to change the secure status.
variable_idstringObligatorio
The identifier for the variable to be updated.
variable_group_idstringObligatorio
The identifier for the variable group containing the variable.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not