PARALLAX

office_365_connector_card

Use webhooks to create Connector Card messages within an Office 365 group

Collection: community.general

Full Name: community.general.office_365_connector_card

Synopsis

Use webhooks to create Connector Card messages within an Office 365 group

Parameters

NameTypeRequiredDefaultDescription
actionslistThis array of objects is used to power the action links found at the bottom of the card.
colorstringAccent color used for branding or indicating status in the card.
sectionslistContains a list of sections to display in the card. For more information see U(https://learn.microsoft.com/en-us/outlook/actionable-messages/message-card-reference#section-fields).
summarystringA string used for summarizing card content. This is the message subject. This is required if the text parameter is not populated.
textstringThe main text of the card. This is rendered below the sender information and optional title, And above any sections or actions present.
titlestringA title for the Connector message. Shown at the top of the message.
webhookstringyesThe webhook URL is given to you when you create a new Connector.

Example

yaml
- name: Create a simple Connector Card
  community.general.office_365_connector_card:
    webhook: https://outlook.office.com/webhook/GUID/IncomingWebhook/GUID/GUID
    text: 'Hello, World!'

- name: Create a Connector Card with the full format
  community.general.office_365_connector_card:
    webhook: https://outlook.office.com/webhook/GUID/IncomingWebhook/GUID/GUID
    summary: This is the summary property
    title: This is the **card's title** property
    text: This is the **card's text** property. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
    color: E81123
    sections:
        - title: This is the **section's title** property
          activity_image: http://connectorsdemo.azurewebsites.net/images/MSC12_Oscar_002.jpg
          activity_title: This is the section's **activityTitle** property
          activity_subtitle: This is the section's **activitySubtitle** property
          activity_text: This is the section's **activityText** property.
          hero_image:
            image: http://connectorsdemo.azurewebsites.net/images/WIN12_Scene_01.jpg
            title: This is the image's alternate text
          text: This is the section's text property. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
          facts:
            - name: This is a fact name
              value: This is a fact value
            - name: This is a fact name
              value: This is a fact value
            - name: This is a fact name
              value: This is a fact value
          images:
            - image: http://connectorsdemo.azurewebsites.net/images/MicrosoftSurface_024_Cafe_OH-06315_VS_R1c.jpg
              title: This is the image's alternate text
            - image: http://connectorsdemo.azurewebsites.net/images/WIN12_Scene_01.jpg
              title: This is the image's alternate text
            - image: http://connectorsdemo.azurewebsites.net/images/WIN12_Anthony_02.jpg
              title: This is the image's alternate text
          actions:
            - "@type": ActionCard
              name: Comment
              inputs:
                - "@type": TextInput
                  id: comment
                  is_multiline: true
                  title: Input's title property
              actions:
                - "@type": HttpPOST
                  name: Save
                  target: http://...
            - "@type": ActionCard
              name: Due Date
              inputs:
                - "@type": DateInput
                  id: dueDate
                  title: Input's title property
              actions:
                - "@type": HttpPOST
                  name: Save
                  target: http://...
            - "@type": HttpPOST
              name: Action's name prop.
              target: http://...
            - "@type": OpenUri
              name: Action's name prop
              targets:
                - os: default
                  uri: http://...
        - start_group: true
          title: This is the title of a **second section**
          text: This second section is visually separated from the first one by setting its **startGroup** property to true.
Search
    ↑ ↓ move↵ openesc close