Share

A JobShare contains a link to a website that contains details about the Job or Jobs associated with the share.

A KnowledgebaseShare contains a link to a website that contains details about knowledgebase content associated with the share.

By default, shares will only include content for steps that have been marked as visible to customers in the workflow configuration. Setting the shareEntireJob option to true will create a share for the entire job, including steps that haven’t been marked as visible to customers. Share links that show the entire job should only be used for internal purposes.

API URLs

• Testing: https://gql-share-external.staging.xoeye.com/graphql
• Production: https://gql-share-external.xoi.io/graphql

Creating a JobShare

See the CreateJobShareInput schema for the details of what is required for this request.

Example Requests

The following query takes in the ID for a single Job for the share and returns the share ID and share link.

mutation CreateJobShare {
  createJobShare(input: { jobId: "a-vision-job-id" }) {
    jobShare {
      id
      shareLink
    }
  }
}

The following query takes in all of the IDs for a list of Jobs for the share and returns the share ID and share link.

Note: The return is exactly the same, regardless of if you share a single job or multiple jobs

mutation CreateJobShare {
  createJobShare(
    input: {
      jobIds: [
        "a-vision-job-id"
        "another-vision-job-id"
        "one-more-vision-job-id"
      ]
    }
  ) {
    jobShare {
      id
      shareLink
    }
  }
}

Example Response

See the JobShareResult schema for the details of what to expect in your response.

{
  "data": {
    "createJobShare": {
      "jobShare": {
        "id": "xa-aaddf1180ba44a0b848fc2745494a59d",
        "shareLink": "https://visionshare.xoeye.com/?id=xa-aaddf1180ba44a0b848fc2745494a59d"
      }
    }
  }
}

Creating a KnowledgebaseShare

See the CreateKnowledgebaseShareInput schema for the details of what is required for this request.

Example Request

The following query takes in a list of knowledgebase content ids for the share and returns the share ID and share link as well as the knowledgebase ids originally given.

mutation CreateKnowledgebaseShare {
  createKnowledgebaseShare(
    input: { knowledgebaseContentIds: ["content-12345.mov"] }
  ) {
    knowledgebaseShare {
      id
      knowledgebaseContentIds
      shareLink
    }
  }
}

Example Response

See the CreateKnowledgebaseShareResult schema for the details of what to expect in your response.

{
  "data": {
    "createKnowledgebaseShare": {
      "knowledgebaseShare": {
        "id": "wkbs-i-f950-df341524c1e044fca244986da763ca41",
        "knowledgebaseContentIds": ["content-12345.mov"],
        "shareLink": "https://visionshare.xoi.io/?id=wkbs-i-f950-df341524c1e044fca244986da763ca41"
      }
    }
  }
}