Chat 2.0 Events docs version 1.1.9

Operations

  • SUB tms-events

    TMS Events

    Accepts one of the following messages:

    • #0project.Created
      • TMS should send it when: Project was created
      • XTRF sends it when: Project or Quote was created
      allOf
      uid: MessageProjectCreated

      Examples

    • #1project.Archived
      • TMS should send it when: Project was archived, deactivated, removed or deleted
      • XTRF sends it when: Project was archived or deleted
      allOf
      uid: MessageProjectArchived

      Examples

    • #2project.ManagerAssigned
      • TMS should send it when: Project Manager was assigned to a Project
      • XTRF sends it when: Project Manager or Project Coordinator was assigned to a Project/Quote
      allOf
      uid: MessageProjectManagerAssigned

      Examples

    • #3project.ManagerUnassigned
      • TMS should send it when: Project Manager was unassigned from a Project
      • XTRF sends it when: Project Manager or Project Coordinator was unassigned from a Project/Quote
      allOf
      uid: MessageProjectManagerUnassigned

      Examples

    • #4project.InfoUpdated
      • TMS should send it when: Project info was updated
      • XTRF sends it when: Project info was updated (excluding information for which there are specific events, for ex. status)
      allOf
      uid: MessageProjectInfoUpdated

      Examples

    • #5project.StatusOpened
      • TMS should send it when: Project status was changed to a status that means the project was opened
      • XTRF sends it when: After Project or Quote was Created
      allOf
      uid: MessageProjectStatusOpened

      Examples

    • #6project.StatusStarted
      • TMS should send it when: Project status was changed to a status that means the project was started
      • XTRF sends it when: in Project job will be started for the first time or when converting quote to project there will be any started job
      allOf
      uid: MessageProjectStatusStarted

      Examples

    • #7project.StatusClosed
      • TMS should send it when: Project status was changed to a status that means the project was closed
      • XTRF sends it when: Project status was changed to Closed
      allOf
      uid: MessageProjectStatusClosed

      Examples

    • #8project.StatusReopened
      • TMS should send it when: Project status was changed to a status that means the project was reopened
      • XTRF sends it when: Project status was changed to Open or Quote status was changed to Pending
      allOf
      uid: MessageProjectStatusReopened

      Examples

    • #9project.StatusCancelled
      • TMS should send it when: Project status was changed to a status that means the project was calceled
      • XTRF sends it when: Project status was changed to Cancelled or Quote status was changed to Rejected
      allOf
      uid: MessageProjectStatusCancelled

      Examples

    • #10job.Created
      • TMS should send it when: Job was created
      • XTRF sends it when: Job was created (in Project or Quote)
      allOf
      uid: MessageJobCreated

      Examples

    • #11job.Archived
      • TMS should send it when: Job was archived, deactivated, removed or deleted. Should be sent if the job was archived as a consequence of archiving a project.
      • XTRF sends it when: Job was archived or deleted
      allOf
      uid: MessageJobArchived

      Examples

    • #12job.VendorAssigned
      • TMS should send it when: Vendor was assigned to a Job in a Project
      • XTRF sends it when: Vendor Contact Person was assigned to a Job in a Project/Quote
      allOf
      uid: MessageJobVendorAssigned

      Examples

    • #13job.VendorUnassigned
      • TMS should send it when: Vendor was unassigned from a Job in a Project
      • XTRF sends it when: Vendor Contact Person was unassigned from a Job in a Project/Quote
      allOf
      uid: MessageJobVendorUnassigned

      Examples

    • #14job.InfoUpdated
      • TMS should send it when: Job info was updated
      • XTRF sends it when: Job type, number, languages or specializations were updated
      allOf
      uid: MessageJobInfoUpdated

      Examples

    • #15job.StatusOpened
      • TMS should send it when: Job status was changed to a status that means the job was opened
      • XTRF sends it when: Job status was changed to Opened, Requested or Assigned
      allOf
      uid: MessageJobStatusOpened

      Examples

    • #16job.StatusStarted
      • TMS should send it when: Job status was changed to a status that means the job was started
      • XTRF sends it when: Job status was changed to Started
      allOf
      uid: MessageJobStatusStarted

      Examples

    • #17job.StatusClosed
      • TMS should send it when: Job status was changed to a status that means the job was closed
      • XTRF sends it when: Job status was changed to Ready
      allOf
      uid: MessageJobStatusClosed

      Examples

    • #18job.StatusReopened
      • TMS should send it when: Job status was changed to a status that means the job was reopened
      • XTRF sends it when: Job was reopened
      allOf
      uid: MessageJobStatusReopened

      Examples

    • #19job.StatusCancelled
      • TMS should send it when: Job status was changed to a status that means the job was cancelled
      • XTRF sends it when: Job status was changed to Cancelled
      allOf
      uid: MessageJobStatusCancelled

      Examples

    • #20job.FilesAdded
      • TMS should send it when: A file was added to a Job
      • XTRF sends it when: A file was added to a Job
      allOf
      uid: MessageJobFilesAdded

      Examples

    • #21job.FilesRemoved
      • TMS should send it when: A file was removed from a Job
      • XTRF sends it when: A file was removed from a Job
      allOf
      uid: MessageJobFilesRemoved

      Examples

    • #22job.offer.AcceptedEvent
      • TMS should send it when: Vendor accepted a Job Offer in TMS
      • XTRF sends it when: Vendor accepted a Job Offer in Vendor Portal
      allOf
      uid: MessageAcceptedEvent

      Examples

    • #23job.offer.RejectedEvent
      • TMS should send it when: Vendor rejected a Job Offer in TMS
      • XTRF sends it when: Vendor rejected a Job Offer in Vendor Portal
      allOf
      uid: MessageRejectedEvent

      Examples

    • #24job.ProspectingRequestedEvent
      • TMS should send it when: New prospecting should be created
      • XTRF sends it when: New prospecting should be created
      allOf
      uid: MessageProspectingRequestedEvent

      Examples

    • #25user.DeletedOrErased
      • TMS should send it when: User was deleted, erased or deactivated in the TMS and has to be removed from the Workspace.
      • XTRF sends it when: HP User or Vendor Contact Person was deleted or erased
      allOf
      uid: MessageUserDeletedOrErased

      Examples

  • SUB job_offers-events

    Job Offers app Events

    Accepts one of the following messages:

    • #0job.offer.vendorSelectionRequested
      • Job offer should send it when: prospecting wants to assign vendor.
      allOf
      uid: MessageJobOfferVendorSelectionRequested

      Examples

    • #1job.offer.sentToVendor
      • Job offer should send it when: cascade offers are sent.
      allOf
      uid: MessageJobOfferSentToVendor

      Examples

    • #2job.offer.vendorResponded
      • Job offer should send it when: vendor responded to active offer.
      allOf
      uid: MessageJobOfferVendorResponded

      Examples

    • #3prospecting.started
      • Job offer should send it when: prospecting started.
      allOf
      uid: MessageProspectingStarted

      Examples

    • #4prospecting.finished
      • Job offer should send it when: prospecting finished.
      allOf
      uid: MessageProspectingFinished

      Examples

    • #5prospecting.cancelled
      • Job offer should send it when: prospecting cancelled.
      allOf
      uid: MessageProspectingCancelled

      Examples

    • #6prospecting.created
      • Job offer should send it when: prospecting is created.
      allOf
      uid: MessageProspectingCreated

      Examples

    • #7prospecting.creationFailed
      • Job offer should send it when: prospecting is not created due to some error.
      allOf
      uid: MessageProspectingCreationFailed

      Examples

Messages

  • #1project.Created
    • TMS should send it when: Project was created
    • XTRF sends it when: Project or Quote was created
    allOf
    uid: MessageProjectCreated
  • #2project.Archived
    • TMS should send it when: Project was archived, deactivated, removed or deleted
    • XTRF sends it when: Project was archived or deleted
    allOf
    uid: MessageProjectArchived
  • #3project.ManagerAssigned
    • TMS should send it when: Project Manager was assigned to a Project
    • XTRF sends it when: Project Manager or Project Coordinator was assigned to a Project/Quote
    allOf
    uid: MessageProjectManagerAssigned
  • #4project.ManagerUnassigned
    • TMS should send it when: Project Manager was unassigned from a Project
    • XTRF sends it when: Project Manager or Project Coordinator was unassigned from a Project/Quote
    allOf
    uid: MessageProjectManagerUnassigned
  • #5project.InfoUpdated
    • TMS should send it when: Project info was updated
    • XTRF sends it when: Project info was updated (excluding information for which there are specific events, for ex. status)
    allOf
    uid: MessageProjectInfoUpdated
  • #6project.StatusOpened
    • TMS should send it when: Project status was changed to a status that means the project was opened
    • XTRF sends it when: After Project or Quote was Created
    allOf
    uid: MessageProjectStatusOpened
  • #7project.StatusStarted
    • TMS should send it when: Project status was changed to a status that means the project was started
    • XTRF sends it when: in Project job will be started for the first time or when converting quote to project there will be any started job
    allOf
    uid: MessageProjectStatusStarted
  • #8project.StatusClosed
    • TMS should send it when: Project status was changed to a status that means the project was closed
    • XTRF sends it when: Project status was changed to Closed
    allOf
    uid: MessageProjectStatusClosed
  • #9project.StatusReopened
    • TMS should send it when: Project status was changed to a status that means the project was reopened
    • XTRF sends it when: Project status was changed to Open or Quote status was changed to Pending
    allOf
    uid: MessageProjectStatusReopened
  • #10project.StatusCancelled
    • TMS should send it when: Project status was changed to a status that means the project was calceled
    • XTRF sends it when: Project status was changed to Cancelled or Quote status was changed to Rejected
    allOf
    uid: MessageProjectStatusCancelled
  • #11job.Created
    • TMS should send it when: Job was created
    • XTRF sends it when: Job was created (in Project or Quote)
    allOf
    uid: MessageJobCreated
  • #12job.Archived
    • TMS should send it when: Job was archived, deactivated, removed or deleted. Should be sent if the job was archived as a consequence of archiving a project.
    • XTRF sends it when: Job was archived or deleted
    allOf
    uid: MessageJobArchived
  • #13job.VendorAssigned
    • TMS should send it when: Vendor was assigned to a Job in a Project
    • XTRF sends it when: Vendor Contact Person was assigned to a Job in a Project/Quote
    allOf
    uid: MessageJobVendorAssigned
  • #14job.VendorUnassigned
    • TMS should send it when: Vendor was unassigned from a Job in a Project
    • XTRF sends it when: Vendor Contact Person was unassigned from a Job in a Project/Quote
    allOf
    uid: MessageJobVendorUnassigned
  • #15job.InfoUpdated
    • TMS should send it when: Job info was updated
    • XTRF sends it when: Job type, number, languages or specializations were updated
    allOf
    uid: MessageJobInfoUpdated
  • #16job.StatusOpened
    • TMS should send it when: Job status was changed to a status that means the job was opened
    • XTRF sends it when: Job status was changed to Opened, Requested or Assigned
    allOf
    uid: MessageJobStatusOpened
  • #17job.StatusStarted
    • TMS should send it when: Job status was changed to a status that means the job was started
    • XTRF sends it when: Job status was changed to Started
    allOf
    uid: MessageJobStatusStarted
  • #18job.StatusClosed
    • TMS should send it when: Job status was changed to a status that means the job was closed
    • XTRF sends it when: Job status was changed to Ready
    allOf
    uid: MessageJobStatusClosed
  • #19job.StatusReopened
    • TMS should send it when: Job status was changed to a status that means the job was reopened
    • XTRF sends it when: Job was reopened
    allOf
    uid: MessageJobStatusReopened
  • #20job.StatusCancelled
    • TMS should send it when: Job status was changed to a status that means the job was cancelled
    • XTRF sends it when: Job status was changed to Cancelled
    allOf
    uid: MessageJobStatusCancelled
  • #21job.FilesAdded
    • TMS should send it when: A file was added to a Job
    • XTRF sends it when: A file was added to a Job
    allOf
    uid: MessageJobFilesAdded
  • #22job.FilesRemoved
    • TMS should send it when: A file was removed from a Job
    • XTRF sends it when: A file was removed from a Job
    allOf
    uid: MessageJobFilesRemoved
  • #23job.offer.AcceptedEvent
    • TMS should send it when: Vendor accepted a Job Offer in TMS
    • XTRF sends it when: Vendor accepted a Job Offer in Vendor Portal
    allOf
    uid: MessageAcceptedEvent
  • #24job.offer.RejectedEvent
    • TMS should send it when: Vendor rejected a Job Offer in TMS
    • XTRF sends it when: Vendor rejected a Job Offer in Vendor Portal
    allOf
    uid: MessageRejectedEvent
  • #25job.ProspectingRequestedEvent
    • TMS should send it when: New prospecting should be created
    • XTRF sends it when: New prospecting should be created
    allOf
    uid: MessageProspectingRequestedEvent
  • #26user.DeletedOrErased
    • TMS should send it when: User was deleted, erased or deactivated in the TMS and has to be removed from the Workspace.
    • XTRF sends it when: HP User or Vendor Contact Person was deleted or erased
    allOf
    uid: MessageUserDeletedOrErased
  • #27prospecting.started
    • Job offer should send it when: prospecting started.
    allOf
    uid: MessageProspectingStarted
  • #28prospecting.finished
    • Job offer should send it when: prospecting finished.
    allOf
    uid: MessageProspectingFinished
  • #29prospecting.cancelled
    • Job offer should send it when: prospecting cancelled.
    allOf
    uid: MessageProspectingCancelled
  • #30prospecting.created
    • Job offer should send it when: prospecting is created.
    allOf
    uid: MessageProspectingCreated
  • #31prospecting.creationFailed
    • Job offer should send it when: prospecting is not created due to some error.
    allOf
    uid: MessageProspectingCreationFailed
  • #32job.offer.vendorSelectionRequested
    • Job offer should send it when: prospecting wants to assign vendor.
    allOf
    uid: MessageJobOfferVendorSelectionRequested
  • #33job.offer.sentToVendor
    • Job offer should send it when: cascade offers are sent.
    allOf
    uid: MessageJobOfferSentToVendor
  • #34job.offer.vendorResponded
    • Job offer should send it when: vendor responded to active offer.
    allOf
    uid: MessageJobOfferVendorResponded
  • #35job.offer.expired
    • Job offer should send it when: vendor offer expires and for every offer separately.
    allOf
    uid: MessageJobOfferExpired

Schemas

  • object
    uid: EventEnvelope

    Envelope shared between messages

  • object
    uid: NameWithDictionaryId

    Object that stores not localized name and id for localizations

  • object
    uid: ProjectUrls
  • object
    uid: ProjectFinance
  • object
    uid: ProjectService
  • object
    uid: ProjectDates
  • object
    uid: ProjectClient
  • object
    uid: Project
  • object
    uid: Job
  • object
    uid: JobOfferVendorDetails
  • JobOfferVendorResponseType
    string
    uid: JobOfferVendorResponseType
      Allowed values:
    • "rejected"
    • "accepted"
    • "negotiated"
  • ProspectingTriggerType
    string
    uid: ProspectingTriggerType
      Allowed values:
    • "automatic"
    • "manual"
    • "tms"
  • ProspectingSelectionTriggerType
    string
    uid: ProspectingSelectionTriggerType
      Allowed values:
    • "automatic"
    • "manual"
  • ProspectingResolutionType
    string
    uid: ProspectingResolutionType
      Allowed values:
    • "vendorRecommended"
    • "noRecommendation"
    • "noProposalsReceived"
    • "recommendedVendorSelected"
    • "otherVendorSelected"
  • object
    uid: ContractProposal
  • ProspectingCreationFailureType
    string
    uid: ProspectingCreationFailureType
      Allowed values:
    • "requestValidationError"
    • "jobNotFound"
    • "prospectingStrategyNotFound"
    • "otherError"