openapi: 3.2.0
info:
  title: Qualtrics Eventsubscriptions API
  version: '0.2'
  description: 'Operations tagged Eventsubscriptions across 2 of this provider''s published API definitions: qualtrics-api-openapi-3.0.json, qualtrics-api-swagger-2.0.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://{apiRegion}.qualtrics.com/API/{apiVersion}
  description: Qualtrics API endpoint for EU region
  variables:
    apiRegion:
      default: fra1
      description: Specify the Qualtrics datacenter prefix according to your account (find it at <your URL>/Q/QualtricsIdsSection/IdsSection)
    apiVersion:
      default: v3
      description: API version to use - default v3
- url: https://fra1.qualtrics.com/API/v3
tags:
- name: Event Subscriptions
paths:
  /eventsubscriptions/:
    post:
      summary: Subscribe to response event
      operationId: webhook-trigger
      x-ms-trigger: single
      parameters: []
      x-ms-notification-content:
        description: Response schema
        schema:
          $ref: '#/components/schemas/EventSubscriptionHookSchema'
      responses:
        '200':
          description: ''
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EventSubscriptionsResponse'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/requestBodies/SubscribeToEventBody'
            example:
              topics: surveyengine.completedResponse.{SurveyID}
              publicationUrl: https://prod-142.westeurope.logic.azure.com:443/workflows/
              encrypt: false
      tags:
      - Event Subscriptions
      security:
      - QualtricsAPIKeyAuth: []
    delete:
      summary: Remove subscription to response event
      operationId: WebhookDelete
      parameters: []
      responses:
        '200':
          description: ''
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EventSubscriptionsResponse'
      tags:
      - Event Subscriptions
      security:
      - QualtricsAPIKeyAuth: []
    x-ms-notification-content:
      description: WebHook registration response
      schema:
        $ref: '#/components/schemas/EventSubscriptionHookSchema_2'
    servers:
    - url: https://{apiRegion}.qualtrics.com/API/{apiVersion}
      description: Qualtrics API endpoint for EU region
      variables:
        apiRegion:
          default: fra1
          description: Specify the Qualtrics datacenter prefix according to your account (find it at <your URL>/Q/QualtricsIdsSection/IdsSection)
        apiVersion:
          default: v3
          description: API version to use - default v3
  /eventsubscriptions/{SubscripionId}:
    get:
      summary: Get event subscriptions
      operationId: Geteventsubscriptions
      parameters:
      - $ref: '#/components/parameters/SubscriptionId'
      responses:
        '200':
          description: ''
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EventSubscriptionsResponse'
      tags:
      - Event Subscriptions
      security:
      - QualtricsAPIKeyAuth: []
    servers:
    - url: https://{apiRegion}.qualtrics.com/API/{apiVersion}
      description: Qualtrics API endpoint for EU region
      variables:
        apiRegion:
          default: fra1
          description: Specify the Qualtrics datacenter prefix according to your account (find it at <your URL>/Q/QualtricsIdsSection/IdsSection)
        apiVersion:
          default: v3
          description: API version to use - default v3
  /eventsubscriptions/{SubscriptionId}:
    get:
      summary: Get event subscriptions
      operationId: GetEventSubscriptions
      parameters:
      - name: SubscriptionId
        required: true
        in: path
        description: ID of event subscription - can be obtained from web hook response
        schema:
          type: string
      responses:
        '200':
          description: Event subscriptions
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EventSubscriptionsResponse'
      tags:
      - Event Subscriptions
    servers:
    - url: https://fra1.qualtrics.com/API/v3
components:
  schemas:
    EventSubscriptionHookSchema:
      type: object
      properties:
        $content-type:
          type: string
          default: application/x-www-form-urlencoded
        $content:
          type: string
        $formdata:
          type: array
          items:
            type: object
            properties:
              key:
                type: string
              value:
                type: string
            required:
            - key
            - value
    EventSubscriptionsResponse:
      type: object
      properties:
        result:
          type: object
          properties:
            result:
              type: object
              properties:
                id:
                  type: string
            meta:
              type: object
              properties:
                httpStatus:
                  type: string
        meta:
          type: object
          properties:
            requestId:
              type: string
            httpStatus:
              type: string
    SubscribeToEventBody:
      type: object
      properties:
        topics:
          type: string
          description: The topics to subscribe to. Must follow the format surveyengine.completedResponse.[SurveyID]
          default: surveyengine.completedResponse.<Insert SurveyID>
        publicationUrl:
          type: string
          description: The internal publication URL - will be generated by PowerAutomate
          x-ms-notification-url: true
          x-ms-visibility: internal
        encrypt:
          type: boolean
      required:
      - topics
      - publicationUrl
    EventSubscriptionHookSchema_2:
      type: object
      properties:
        $content-type:
          x-ms-summary: Content type
          type: string
          default: application/x-www-form-urlencoded
          x-ms-visibility: internal
        $content:
          x-ms-summary: Content
          type: string
          x-ms-visibility: internal
          default: x
        $formdata:
          type: array
          x-ms-summary: Questions and answers
          items:
            type: object
            properties:
              key:
                type: string
                x-ms-summary: ' : Question'
              value:
                type: string
                x-ms-summary: ': Answer'
            required:
            - key
            - value
      required:
      - $content-type
      - $content
  requestBodies:
    SubscribeToEventBody:
      required: true
      content:
        application/json:
          schema:
            type: object
            properties:
              topics:
                type: string
              publicationUrl:
                type: string
              encrypt:
                type: boolean
  parameters:
    SubscriptionId:
      name: SubscriptionId
      required: true
      in: path
      schema:
        type: string
  securitySchemes:
    QualtricsAPIKeyAuth:
      type: apiKey
      in: header
      name: X-API-TOKEN
    api_key:
      type: apiKey
      name: X-API-TOKEN
      in: header
x-refined-from:
- qualtrics-api-openapi-3.0.json
- qualtrics-api-swagger-2.0.json