Microsoft Teams integration

How to integrate your workflows with Microsoft Teams using codemagic.yaml

Microsoft Teams is a communication and collaboration platform that allows teams to chat, share files, and integrate with external services. If your team uses Microsoft Teams, you can configure Codemagic to send build status notifications directly to a Teams channel using an Incoming Webhook.

Create an Incoming Webhook in Teams

To receive messages in a Teams channel, you first need to configure the Incoming Webhook:

1. In Microsoft Teams, open the channel you want to post notifications to.

2. Click More options (⋮) → Connectors → Edit.

3. Add an Incoming Webhook.

4. Copy the generated Webhook URL.

Configuring access to Teams in Codemagic

1. Open your Codemagic app settings, and go to the Environment variables tab.

2. Enter the desired Variable name, e.g. TEAMS_WEBHOOK_URL.

3. Paste the Webhook URL you copied from Teams as the Variable value.

4. Enter the variable group name, e.g. teams_credentials. Click the button to create the group.

5. Make sure the Secret option is selected.

6. Click the Add button to add the variable.

7. Add the variable group to your codemagic.yaml file:

  environment:
    groups:
      - teams_credentials

Post a message to Microsoft Teams

You can send messages to a Teams channel using a simple curl request to the webhook.

The following example shows how you can check the publishing status of a build and send a notification to Teams when publishing succeeds:

publishing:
  scripts:
    # Fetch the artifact URL for the .ipa file
    ARTIFACT_LINK=$(echo $CM_ARTIFACT_LINKS | jq -r '.[] | select(.name | endswith(".ipa")) | .url')

    # Get first 7 digits of commit hash
    COMMIT=$(echo "${CM_COMMIT}" | sed 's/^\(........\).*/\1/;q')

    # Get commit message
    COMMIT_MESSAGE=$(git log --format=%B -n 1 $CM_COMMIT)

    # Get commit author
    AUTHOR=$(git show -s --format='%ae' $CM_COMMIT)

    # Send notification to MS Teams
    curl -H "Content-Type: application/json" \
      -d "{
            \"title\": \"📦 New Codemagic Build\",
            \"text\": \"**Branch:** $CM_BRANCH <br>**Commit:** \`$COMMIT\` <br>**Author:** $AUTHOR <br>**Commit message:** $COMMIT_MESSAGE <br>**Artifact:** <a href='$ARTIFACT_LINK'>Download IPA</a>\"
          }" \
      $TEAMS_WEBHOOK_URL