Decisiv Webhooks Events API

openapi: 3.2.0
info:
  version: 0.48.24
  termsOfService: https://www.decisiv.com/terms-of-use
  contact:
    name: Decisiv Support
    email: support@decisiv.com
    url: https://www.decisiv.com
  title: Account Management Webhooks Events API
  description: Inside of **Decisiv SRM Gateway**, the `Account Management` module represents all the accounts the current user has access granted to
  license:
    name: Proprietary
    identifier: proprietary
    url: https://www.decisiv.com/terms-of-use/
servers:
- url: https://srm-api.staging.decisivapps.com
- url: https://srm-api.decisivapps.com
security:
- OAuth2AuthorizationCode: []
  AccessToken: []
- OAuth2Password: []
  AccessToken: []
tags:
- name: Webhooks Events
paths:
  /account_management/v1/accounts/{account_id}/webhook_events:
    get:
      summary: List webhook events which are available for subscription by the designated account
      tags:
      - Webhooks Events
      operationId: getWebhooksEventsbyAccountId
      parameters:
      - name: account_id
        in: path
        required: true
        schema:
          type: string
      - name: page[number]
        in: query
        required: false
        schema:
          type: integer
          default: 1
          minimum: 1
        description: Sets the desired `page` when encountering larger result sets
      - name: page[size]
        in: query
        required: false
        schema:
          type: integer
          default: 25
          minimum: 1
        description: Sets the desired maximum number of results per page
      responses:
        '200':
          description: Returns a list of webhook events available for the requested Account
          content:
            application/vnd.api+json:
              example:
                data:
                - type: webhook_events
                  id: 5ec4100c-d5b4-417a-9002-549104b4f1cb
                  attributes:
                    name: asset_management:service_request_accepted
                    description: Serivce location has accepted incoming service request from Asset Management customer resulting in the generation of a Case
              schema:
                $ref: '#/components/schemas/webhook_events'
        '400':
          description: Account filter is missing
          content:
            application/vnd.api+json:
              example:
                errors:
                - title: Record not found
                  status: '404'
                  source:
                    parameter: account_id
              schema:
                $ref: '#/components/schemas/errors_response'
components:
  schemas:
    webhook_events:
      type: object
      required:
      - data
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/webhook_event'
        meta:
          type: object
    webhook_event:
      type: object
      properties:
        id:
          type: string
          format: uuid
        type:
          type: string
          enum:
          - webhook_events
        attributes:
          type: object
          properties:
            name:
              type: string
              description: Referential title of the webhook event; scoped to the applicable SRM module.
              example: maintenance:scheduled_operation_due
            description:
              type: string
              description: Detailed explanation of the webhook event.
      required:
      - attributes
      - type
      - id
    errors_response:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/error_response'
      required:
      - errors
    error_response:
      type: object
      properties:
        status:
          type: string
        title:
          type: string
        detail:
          type:
          - string
          - 'null'
        code:
          type:
          - string
          - 'null'
        source:
          type: object
          properties:
            parameter:
              type:
              - string
              - 'null'
            pointer:
              type:
              - string
              - 'null'
        links:
          type: object
          description: Links related to this error (e.g. documentation reference).
          additionalProperties:
            type: string
            format: uri
      required:
      - status
      - title
  securitySchemes:
    AccessToken:
      type: http
      scheme: bearer
      bearerFormat: JWT
    OAuth2AuthorizationCode:
      type: oauth2
      description: OAuth 2.0 Authorization Code flow. This is the required flow for new integrations. See https://api-docs.decisiv.net/docs/api/oauth/
      flows:
        authorizationCode:
          authorizationUrl: https://login.decisiv.net/auth/api_gateway
          tokenUrl: https://login.decisiv.net/oauth/token
          refreshUrl: https://login.decisiv.net/oauth/token
          scopes: {}
    OAuth2Password:
      type: oauth2
      description: '**Deprecated.** OAuth 2.0 Password flow. New integrations must use the Authorization Code flow (`OAuth2AuthorizationCode`); this flow remains available only during the migration window and will be removed in a future release. See https://api-docs.decisiv.net/docs/api/oauth/'
      flows:
        password:
          tokenUrl: https://login.decisiv.net/oauth/token
          scopes: {}