Skip to main content

Microsoft 365 Copilot Destination

Nexla's bi-directional connectors allow data to flow both to and from any location, making it simple to create a FlexFlow, DB-CDC, Spark ETL, or Replication data flow that sends data to a Microsoft 365 Copilot location.
copilot_api.png

Microsoft 365 Copilot

Create a Microsoft 365 Copilot Destination​

  1. Click the + icon on the Nexset that will be sent to the Microsoft 365 Copilot destination, and select the Send to Destination option from the menu.

  2. Select the Microsoft 365 Copilot connector from the list of available destination connectors. Then, select the credential that will be used to connect to the Microsoft 365 Copilot organization, and click Next; or, create a new Microsoft 365 Copilot credential for use in this flow.

  3. In Nexla, Microsoft 365 Copilot destinations can be created using pre-built endpoint templates, which expedite destination setup for common Microsoft 365 Copilot endpoints. Each template is designed specifically for the corresponding Microsoft 365 Copilot endpoint, making destination configuration easy and efficient.
    • To configure this destination using a template, follow the instructions in Configure Using a Template.

    Microsoft 365 Copilot destinations can also be configured manually, allowing you to send data to Microsoft 365 Copilot endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
    • To configure this destination manually, follow the instructions in Configure Manually.

Configure Using a Template​

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Microsoft 365 Copilot endpoints. Each template is designed specifically for the corresponding Microsoft 365 Copilot endpoint, making destination setup easy and efficient.

  • To configure this destination using a template, select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

    Create externalConnection

    This endpoint creates a new external connection in Microsoft 365 Copilot, establishing a link to an external data source that can be indexed and surfaced in Copilot search results and responses. Use this endpoint when you need to set up a new connection for ingesting external data into Copilot.

    • Enter the base URL for Microsoft Graph API in the Base URL Graph field. The default value is https://graph.microsoft.com, which is the standard base URL for Microsoft Graph API requests. This base URL is used to construct the full endpoint URL for creating external connections.
    • Enter the API version in the API Version field. Use v1.0 for stable APIs that are production-ready, or beta for preview features and the latest capabilities. The default is typically v1.0 for production use, as it provides stable, well-tested functionality. Use beta if you need access to the latest features that may not yet be available in v1.0.

    • The endpoint requires connection configuration details in the request body, including:

      • id: A unique identifier for the connection (e.g., "contosohr" or "fabrikam-crm")
      • name: A display name for the connection (e.g., "Contoso HR System")
      • description: A description of what the connection provides
      • connectorId: The ID of the connector type (e.g., "AzureActiveDirectory" for Azure AD, or a custom connector ID)

    External connections must be created before you can ingest items into Copilot. This endpoint establishes the connection framework that will be used for subsequent item ingestion operations.

    Create or update schema

    This endpoint defines or updates the schema for an external connection, specifying the structure and properties of items that will be indexed and made searchable within Microsoft 365 Copilot. Use this endpoint when you need to configure the data structure for items that will be ingested into Copilot.

    • Enter the base URL for Microsoft Graph API in the Base URL Graph field. The default value is https://graph.microsoft.com.
    • Enter the API version in the API Version field. Use v1.0 for stable APIs or beta for preview features.

    • The endpoint requires schema definition in the request body, including property definitions, data types, and searchable fields. The schema defines the structure of items that will be ingested into the connection. Each property in the schema specifies:

      • name: The property name (e.g., "title", "content", "author")
      • type: The data type (e.g., "String", "DateTime", "Int64")
      • isSearchable: Whether the property can be searched in Copilot queries
      • isQueryable: Whether the property can be used in query filters
      • isRetrievable: Whether the property is returned in search results
    • The connection ID from your credential configuration (or specified in the URL path) is used to identify which connection's schema to update. The connection must already exist before you can update its schema.

    Schema definition is required before ingesting items into an external connection. The schema defines the structure of your data and determines which fields are searchable and indexable in Copilot.

    Create externalItem

    This endpoint ingests or updates an individual external item into a Microsoft 365 Copilot connection, making the content discoverable and accessible through Copilot's AI-powered search and responses. Use this endpoint when you need to add or update content items in your Copilot external connection.

    • Enter the base URL for Microsoft Graph API in the Base URL Graph field. The default value is https://graph.microsoft.com.
    • Enter the API version in the API Version field. Use v1.0 for stable APIs or beta for preview features.
    • Enter the external connection ID in the External Connection ID field. This identifies which connection the item will be added to. The connection ID is the unique identifier you specified when creating the external connection (e.g., "contosohr" or "fabrikam-crm"). The connection must exist and have a schema defined before you can ingest items into it.
    • Enter a unique identifier for the item in the External Item ID field. This ID is used to track, update, and reference the item within the Copilot connection. The item ID should be unique within the connection and can be any string value (e.g., "doc-123", "employee-456", or a GUID). Use meaningful IDs that help you identify the item, as this ID is used when updating or deleting items.

    • The endpoint requires item data in the request body, including:

      • acl: Access control list specifying who can access the item
      • content: The main content of the item (text, HTML, etc.)
      • properties: Properties that match the connection's schema definition
      • title: A title for the item that appears in search results

    Items ingested through this endpoint become searchable in Microsoft 365 Copilot within a few minutes of ingestion. Ensure item data matches the schema defined for the connection and includes all required properties. Items can be updated by sending a PUT request with the same item ID - this will replace the existing item with the new data. To delete an item, send a DELETE request to the same endpoint URL. The indexing process may take a few minutes, so items may not appear in Copilot search results immediately after ingestion.

Configure Manually​

Microsoft 365 Copilot destinations can be manually configured to send data to any valid Microsoft Graph External Connections API endpoint.

Using manual configuration, you can also configure Nexla to automatically send the response received from the Microsoft 365 Copilot API after each call to a new Nexla webhook data source.

API Method​

  1. To manually configure this destination, select the Advanced tab at the top of the configuration screen.

  2. Select the API method that will be used for calls to the Microsoft 365 Copilot API from the Method pulldown menu.

Data Format​

  1. Select the format in which the Nexset data will be sent to the Microsoft 365 Copilot API from the Content Format pulldown menu. Nexla will automatically convert the data to the selected format for each API call. Microsoft Graph API typically uses JSON format for request bodies.

API Endpoint URL​

  1. Enter the URL of the Microsoft 365 Copilot API endpoint to which you want to send the Nexset data in the URL field. Microsoft Graph API endpoints typically follow the pattern https://graph.microsoft.com/v1.0/external/connections/{connectionId}/items/{itemId} or https://graph.microsoft.com/beta/external/connections/{connectionId}/items/{itemId} for beta features. For update/upsert operations, include the ID of the object to be updated at the end of the URL.

Request Headers​

Optional

  • If Nexla should include any additional request headers in API calls to this destination, enter the headers & corresponding values as comma-separated pairs in the Request Headers field (e.g., header1:value1,header2:value2).

    You do not need to include any headers already present in the credentials. Microsoft Graph API uses standard OAuth 2.0 Bearer token authentication, which is handled automatically by Nexla based on your credential configuration.

Exclude Attributes from the Call​

Optional

  • If any record attributes in the Nexset should be omitted when sending data to this Microsoft 365 Copilot destination, select the attributes from the Exclude Attributes pulldown menu.

  • Any number of attributes can be selected for exclusion, and all excluded attributes will be shown in the field. To remove an attribute from the list, click the X icon next to the attribute name.

Response Webhook​

Optional

Nexla can automatically send the response received from the Microsoft 365 Copilot API after each call to a new Nexla webhook data source. This option allows you to keep track of the status of each API call and any additional information returned after each call.

  • To enable this option, check the box next to Would you like to process the API response as a Nexla Webhook source?.

Sample Request Payload​

Sample request payloads containing a portion of the Nexset data that will be sent to the Microsoft 365 Copilot API endpoint based on the current settings are shown in the Sample Payload panel on the right. These samples can be referenced to ensure that the destination and request settings are correctly configured.

  • Click on a sample request payload to expand it and view the complete payload content.

  • Sample payloads are automatically updated with each setting change, making it easy to verify that changes achieve the desired effect.

Endpoint Testing (Manual Configuration)​

After all endpoint settings have been configured, Nexla can send a test payload to the Microsoft 365 Copilot API to ensure that the destination is configured correctly.

  1. To send a test payload, select the Test button at the top of the Sample Payload panel, and click on a listed sample payload to expand it.

  2. If any modifications to the sample payload are needed, make the necessary changes directly within the sample window.

  3. Click the Send Test Data button at the top of a sample payload to send the test payload to the Microsoft 365 Copilot API using the current settings.

Save & Activate the Destination​

  • Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To send the data to the configured Microsoft 365 Copilot external connection, open the destination resource menu, and select Activate.

    The Nexset data will not be sent to the Microsoft 365 Copilot external connection until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.