SEDNA Event API API

openapi: 3.0.1
info:
  contact:
    name: Support
    url: https://support.sedna.com
  termsOfService: https://www.sedna.com/terms-of-service
  title: Sedna Authentication Event API API
  version: '2019-01-01'
servers:
- description: Platform endpoint
  url: https://{tenant}.sednanetwork.com/platform
  variables:
    tenant:
      default: example
      description: Your tenant's unique identifier
security:
- Basic: []
- OAuth: []
tags:
- name: Event API
paths:
  /2019-01-01/event:
    get:
      description: 'Fetch a collection of events


        Required API Permissions: EVENT_READ'
      operationId: getEvents
      parameters:
      - example: event.message.received
        in: query
        name: filter[eventType]
        schema:
          type: string
      - example: '160573430553538575444254826660000016384'
        in: query
        name: page[cursor]
        schema:
          type: string
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EventCollection'
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/EventCollection'
          description: default response
      tags:
      - Event API
  /2019-01-01/event/latest:
    get:
      description: 'Fetch the latest event


        Required API Permissions: EVENT_READ'
      operationId: getLatestEvent
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EventCollection'
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/EventCollection'
          description: default response
      tags:
      - Event API
  /2019-01-01/event/{id}:
    get:
      description: 'Fetch an event


        Required API Permissions: EVENT_READ'
      operationId: getEvent
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EventSingle'
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/EventSingle'
          description: default response
      tags:
      - Event API
  /2019-01-01/event/{id}/category-tag:
    get:
      description: 'Fetch an event''s related category tag


        Required API Permissions: EVENT_READ, CATEGORYTAG_READ'
      operationId: getEventCategoryTag
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CategoryTagSingle'
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/CategoryTagSingle'
          description: default response
      tags:
      - Event API
  /2019-01-01/event/{id}/job-reference:
    get:
      description: 'Fetch the job reference related to the event


        Required API Permissions: EVENT_READ, JOBREFERENCE_READ'
      operationId: getEventJobReference
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobReferenceSingle'
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/JobReferenceSingle'
          description: default response
      tags:
      - Event API
  /2019-01-01/event/{id}/message:
    get:
      description: 'Fetch the message related to the event


        Required API Permissions: EVENT_READ, MESSAGE_READ'
      operationId: getEventMessage
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageSingle'
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/MessageSingle'
          description: default response
      tags:
      - Event API
  /2019-01-01/event/{id}/relationships/category-tag:
    get:
      description: 'Fetch an event''s category tag relationship


        Required API Permissions: EVENT_READ'
      operationId: getEventCategoryTagRelationships
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CategoryTagRelToOne'
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/CategoryTagRelToOne'
          description: default response
      tags:
      - Event API
  /2019-01-01/event/{id}/relationships/job-reference:
    get:
      description: 'Fetch the job reference relationship related to the event


        Required API Permissions: EVENT_READ'
      operationId: getEventJobReferenceRelationships
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobReferenceRelToOne'
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/JobReferenceRelToOne'
          description: default response
      tags:
      - Event API
  /2019-01-01/event/{id}/relationships/message:
    get:
      description: 'Fetch the message relationship related to the event


        Required API Permissions: EVENT_READ'
      operationId: getEventMessageRelationships
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageRelToOne'
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/MessageRelToOne'
          description: default response
      tags:
      - Event API
components:
  schemas:
    MessageTag:
      type: object
      properties:
        assignedToUserId:
          type: string
        createdAt:
          type: string
          format: date-time
        eventId:
          $ref: '#/components/schemas/EventId'
        messageId:
          type: string
        messageTagId:
          $ref: '#/components/schemas/MessageTagId'
        removedAt:
          type: string
          format: date-time
        removedByUserId:
          type: string
        tag:
          $ref: '#/components/schemas/Tag'
        tagId:
          $ref: '#/components/schemas/TagId'
        userId:
          type: string
    UserRelToMany:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/UserRelData'
        links:
          $ref: '#/components/schemas/UserRelLinks'
    UserRelLinks:
      type: object
      properties:
        related:
          type: string
        self:
          type: string
    CategoryTagRelationships:
      type: object
      properties:
        team:
          $ref: '#/components/schemas/TeamRelToMany'
    JobReferenceLinks:
      type: object
      properties:
        self:
          type: string
    CategoryTagRelToMany:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/CategoryTagRelData'
        links:
          $ref: '#/components/schemas/CategoryTagRelLinks'
    MessageRelData:
      type: object
      properties:
        id:
          type: string
        type:
          type: string
    TeamRelToMany:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/TeamRelData'
        links:
          $ref: '#/components/schemas/TeamRelLinks'
    DocumentRelData:
      type: object
      properties:
        id:
          type: string
        type:
          type: string
    MessageSingleMeta:
      type: object
      properties:
        composeUrl:
          type: string
    EventId:
      type: object
      properties:
        id:
          type: integer
          format: int64
    TagId:
      type: object
      properties:
        id:
          type: integer
          format: int64
    EventResource:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/EventAttributes'
        id:
          type: string
        links:
          $ref: '#/components/schemas/EventLinks'
        relationships:
          $ref: '#/components/schemas/EventRelationships'
        type:
          type: string
          description: the type of the resource
          enum:
          - event
    EventSingle:
      type: object
      description: The resource
      properties:
        data:
          $ref: '#/components/schemas/EventResource'
        links:
          $ref: '#/components/schemas/EventSingleLinks'
    UserRelData:
      type: object
      properties:
        id:
          type: string
        type:
          type: string
    CategoryTagAttributes:
      type: object
      properties:
        archived:
          type: boolean
        disableFollow:
          type: boolean
        label:
          type: string
        name:
          type: string
    TagName:
      type: object
      properties:
        value:
          type: string
    TeamRelLinks:
      type: object
      properties:
        related:
          type: string
        self:
          type: string
    Tag:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/TagId'
        name:
          $ref: '#/components/schemas/TagName'
        tagLabel:
          $ref: '#/components/schemas/TagLabel'
        tagTypeId:
          type: integer
          format: int32
    ResourceObjectResponse:
      type: object
      properties:
        id:
          type: string
        type:
          type: string
    CategoryTagRelToOne:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/CategoryTagRelData'
        links:
          $ref: '#/components/schemas/CategoryTagRelLinks'
    JobReferenceSingle:
      type: object
      description: The resource
      properties:
        data:
          $ref: '#/components/schemas/JobReferenceResource'
        links:
          $ref: '#/components/schemas/JobReferenceSingleLinks'
    JobReferenceSingleLinks:
      type: object
      properties:
        self:
          type: string
    TeamRelData:
      type: object
      properties:
        id:
          type: string
        type:
          type: string
    JobReferenceRelToMany:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/JobReferenceRelData'
        links:
          $ref: '#/components/schemas/JobReferenceRelLinks'
    JobReferenceResource:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/JobReferenceAttributes'
        id:
          type: string
        links:
          $ref: '#/components/schemas/JobReferenceLinks'
        relationships:
          $ref: '#/components/schemas/JobReferenceRelationships'
        type:
          type: string
          description: the type of the resource
          enum:
          - job-reference
    Company:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ResourceObjectIdentifier'
    Sender:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ResourceObjectIdentifier'
        meta:
          $ref: '#/components/schemas/MetaObject'
    MessageReadResource:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/MessageReadAttributes'
        id:
          type: string
        links:
          $ref: '#/components/schemas/MessageLinks'
        meta:
          $ref: '#/components/schemas/MessageMeta'
        relationships:
          $ref: '#/components/schemas/MessageRelationships'
        type:
          type: string
    MetaObject:
      type: object
    CategoryTagRelData:
      type: object
      properties:
        id:
          type: string
        messageTag:
          $ref: '#/components/schemas/MessageTag'
        type:
          type: string
    MessageLinks:
      type: object
      properties:
        self:
          type: string
    MessageMeta:
      type: object
      properties:
        download:
          type: string
    JobReferenceRelToOne:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/JobReferenceRelData'
        links:
          $ref: '#/components/schemas/JobReferenceRelLinks'
    CategoryTagSingle:
      type: object
      description: The resource
      properties:
        data:
          $ref: '#/components/schemas/CategoryTagResource'
        links:
          $ref: '#/components/schemas/CategoryTagSingleLinks'
    CategoryTagSingleLinks:
      type: object
      properties:
        self:
          type: string
    PrivateLabelRelLinks:
      type: object
      properties:
        related:
          type: string
        self:
          type: string
    JobReferenceRelationships:
      type: object
      properties:
        company:
          $ref: '#/components/schemas/Company'
        tag:
          $ref: '#/components/schemas/Tag'
        team:
          $ref: '#/components/schemas/TeamRelToMany'
        user:
          $ref: '#/components/schemas/UserRelToMany'
    ResourceObjectIdentifier:
      type: object
      properties:
        id:
          type: string
        meta:
          $ref: '#/components/schemas/MetaObject'
        type:
          type: string
    EventCollectionLinks:
      type: object
      properties:
        first:
          type: string
        next:
          type: string
        self:
          type: string
    EventLinks:
      type: object
      properties:
        self:
          type: string
    MessageSingle:
      type: object
      description: The resource
      properties:
        data:
          $ref: '#/components/schemas/MessageReadResource'
        included:
          type: array
          items:
            $ref: '#/components/schemas/ResourceObjectResponse'
        links:
          $ref: '#/components/schemas/MessageSingleLinks'
        meta:
          $ref: '#/components/schemas/MessageSingleMeta'
    MessageReadAttributes:
      type: object
      properties:
        bcc:
          type: array
          items:
            type: string
        bodyHtml:
          type: string
        bodyText:
          type: string
        cc:
          type: array
          items:
            type: string
        from:
          type: array
          items:
            type: string
        fromEmail:
          type: string
        fromName:
          type: string
        hasAttachment:
          type: boolean
        inReplyTo:
          type: string
        messageId:
          type: string
        quarantineStatus:
          type: string
        receivedAt:
          type: string
          format: date-time
        references:
          type: string
        sentAt:
          type: string
          format: date-time
        signed:
          type: string
          enum:
          - UNVERIFIED
          - UNSIGNED
          - VERIFIED
          - FAILED_VERIFICATION
        snippet:
          type: string
        subject:
          type: string
        to:
          type: array
          items:
            type: string
    EventRelationships:
      type: object
      properties:
        category-tag:
          $ref: '#/components/schemas/CategoryTagRelToOne'
        job-reference:
          $ref: '#/components/schemas/JobReferenceRelToOne'
        message:
          $ref: '#/components/schemas/MessageRelToOne'
    MessageRelationships:
      type: object
      properties:
        category-tag:
          $ref: '#/components/schemas/CategoryTagRelToMany'
        document:
          $ref: '#/components/schemas/DocumentRelToMany'
        job-reference:
          $ref: '#/components/schemas/JobReferenceRelToMany'
        message_thread_summary:
          $ref: '#/components/schemas/MessageThreadSummary'
        private-label:
          $ref: '#/components/schemas/PrivateLabelRelToMany'
        sender:
          $ref: '#/components/schemas/Sender'
        team:
          $ref: '#/components/schemas/TeamRelToMany'
    MessageTagId:
      type: object
      properties:
        id:
          type: integer
          format: int64
    DocumentRelToMany:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/DocumentRelData'
        links:
          $ref: '#/components/schemas/DocumentRelLinks'
    TagLabel:
      type: object
      properties:
        value:
          type: string
    EventCollection:
      type: object
      description: A collection of resources
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/EventResource'
        links:
          $ref: '#/components/schemas/EventCollectionLinks'
    MessageRelToOne:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/MessageRelData'
        links:
          $ref: '#/components/schemas/MessageRelLinks'
    JobReferenceAttributes:
      type: object
      properties:
        archived:
          type: boolean
        attributes:
          type: string
        createdAt:
          type: string
        date:
          type: string
        foreignKey:
          type: string
        modifiedAt:
          type: string
        name:
          type: string
        source:
          type: string
        tagId:
          type: string
        type:
          type: string
      required:
      - name
    MessageThreadSummary:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ResourceObjectIdentifier'
    CategoryTagRelLinks:
      type: object
      properties:
        related:
          type: string
        self:
          type: string
    EventSingleLinks:
      type: object
      properties:
        self:
          type: string
    DocumentRelLinks:
      type: object
      properties:
        related:
          type: string
        self:
          type: string
    PrivateLabelRelToMany:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/PrivateLabelRelData'
        links:
          $ref: '#/components/schemas/PrivateLabelRelLinks'
    CategoryTagResource:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/CategoryTagAttributes'
        id:
          type: string
        links:
          $ref: '#/components/schemas/CategoryTagLinks'
        relationships:
          $ref: '#/components/schemas/CategoryTagRelationships'
        type:
          type: string
          description: the type of the resource
          enum:
          - category-tag
    JobReferenceRelLinks:
      type: object
      properties:
        related:
          type: string
        self:
          type: string
    MessageSingleLinks:
      type: object
      properties:
        self:
          type: string
    MessageRelLinks:
      type: object
      properties:
        related:
          type: string
        self:
          type: string
    EventAttributes:
      type: object
      properties:
        eventType:
          type: string
        time:
          type: string
    JobReferenceRelData:
      type: object
      properties:
        id:
          type: string
        messageTag:
          $ref: '#/components/schemas/MessageTag'
        type:
          type: string
    CategoryTagLinks:
      type: object
      properties:
        self:
          type: string
    PrivateLabelRelData:
      type: object
      properties:
        id:
          type: string
        type:
          type: string
  securitySchemes:
    Basic:
      description: The basic auth scheme only requires the API-Specific username/password to be set.
      scheme: basic
      type: http
    OAuth:
      description: This API prefers OAuth 2 with client credentials flow. You can create your credentials in the <a href='https://{tenant}.sednanetwork.com/platform/settings/api-credential-management'>Api Credential Management page</a>.
      flows:
        clientCredentials:
          scopes:
            CATEGORYTAG_DELETE: Delete category tags
            CATEGORYTAG_READ: Read category tags
            CATEGORYTAG_WRITE: Create and update category tags
            CHARTERING_DELETE: Delete chartering (Pulse) information
            CHARTERING_READ: Read chartering (Pulse) information
            CHARTERING_WRITE: Create chartering (Pulse) information
            COMMENT_READ: Read message comments
            COMPANY_READ: Read company info
            COMPANY_WRITE: Update company info (eg. signature)
            CONTACTGROUP_DELETE: Delete contact groups
            CONTACTGROUP_READ: Read contact groups
            CONTACTGROUP_WRITE: Create and update contact groups
            CONTACT_DELETE: Delete contacts
            CONTACT_READ: Read contacts
            CONTACT_WRITE: Create and update contacts
            CRMENTITY_DELETE: Delete CRM contacts
            CRMENTITY_READ: Read CRM contacts
            CRMENTITY_WRITE: Create and update CRM Contacts
            DOCUMENT_READ: Read and download attachments
            EVENT_READ: Read events from the events endpoint
            JOBREFERENCE_DELETE: Delete job references
            JOBREFERENCE_READ: Read job references
            JOBREFERENCE_WRITE: Create and update job references
            KEYWORD_DELETE: Delete custom keywords
            KEYWORD_READ: Read custom keywords
            KEYWORD_WRITE: Create and update custom keywords
            LEGAL_HOLD_DELETE: Delete legal holds
            LEGAL_HOLD_READ: Read legal holds
            LEGAL_HOLD_WRITE: Create and update legal holds
            MESSAGE_DELETE: Archive email messages
            MESSAGE_READ: Read (draft) email messages
            MESSAGE_RETENTION_SETTINGS_READ: Read message retention settings
            MESSAGE_RETENTION_SETTINGS_WRITE: Update message retention settings
            MESSAGE_WRITE: Create and send (draft) email messages
            PERSONAL_DATA_UNREDACTED_READ: Read unredacted emails with personal data
            QUARANTINED_MESSAGE_READ: Read quarantined email messages
            QUARANTINED_MESSAGE_WRITE: Release quarantined email messages
            RETENTION_POLICY_DELETE: Delete retention policies
            RETENTION_POLICY_READ: Read retention policies
            RETENTION_POLICY_WRITE: Create and update retention policies
            SAVEDSEARCH_DELETE: Remove saved searches
            SAVEDSEARCH_READ: Read saved search details
            SAVEDSEARCH_WRITE: Create and update saved searches
            TEAM_DELETE: Delete teams
            TEAM_READ: Read team details
            TEAM_WRITE: Create and update teams
            TEMPLATE_READ: Read templates
            USER_DELETE: Archive users
            USER_READ: Read user details
            USER_WRITE: Create and update users
            WORKFLOW_DELETE: Delete workflows
            WORKFLOW_READ: Read workflow details
            WORKFLOW_WRITE: Create and update workflows
          tokenUrl: https://{tenant}.sednanetwork.com/platform/oauth/token
      type: oauth2