Skip to content
/Mutations

GraphQL Overview

Download GraphQL schema
visibly-api.graphql

Queries

Overview

Mutations

Overview

createNotificationSubscription

(...args)
NotificationSubscription!,non-null

Create an HTTPS notification subscription (webhook) with built-in delivery retries (exponential back off over ~24 hours) by specifying the URL which will receive the HTTP POST request as the endpoint. Leverage Basic and Digest Access Authentication by using a URL formatted as https://user:password@domain.com or https://user@domain.com, respectively. (The password will be encrypted using TLS/SSL and not sent in plaintext).

A confirmation message will be sent to the endpoint specified in each created notification subscriptions. Navigate to the URL in the confirmation message to confirm the subscription. Unconfirmed subscriptions will be automatically deleted 3 days after their creation.

Alternatively, create an EMAIL notification subscription by specifying an email address as the endpoint.

Arguments

type
NotificationSubscriptionType!,non-nullrequired
endpoint
String!,non-nullrequired

Return type

NotificationSubscription!
type
NotificationSubscriptionType!,non-null
id
String!,non-null
endpoint
String!,non-null
Mutation sample
mutation createNotificationSubscription($type: NotificationSubscriptionType!, $endpoint: String!) {
  createNotificationSubscription(type: $type, endpoint: $endpoint) {
    type 
    id 
    endpoint 
  }
}
Variables
{
  "type": "HTTPS",
  "endpoint": "Example String"
}
Response sample
{
  "data": {
    "type": "HTTPS",
    "id": "Example String",
    "endpoint": "Example String"
  }
}

deleteNotificationSubscription

(subscriptionId)
Boolean!,non-null

Delete a notification subscription by its subscriptionId

Arguments

subscriptionId
String!,non-nullrequired

Return type

Boolean!

The Boolean scalar type represents true or false.

Mutation sample
mutation deleteNotificationSubscription($subscriptionId: String!) {
  deleteNotificationSubscription(subscriptionId: $subscriptionId) 
}
Variables
{
  "subscriptionId": "Example String"
}
Response sample
{
  "data": true
}

uploadFile

(fileUpload)
FileUpload!,non-null

Specify a file name and type for a given file to be uploaded and get a fileId and uploadUrl for it.

Use HTTP POST to upload the file content to the uploadUrl. The uploadUrl has a 15-minute expiration time so use it before then.

Pass the fileId as a parameter to other mutations, but only after posting the file content to the uploadUrl.

Arguments

fileUpload
FileUploadInput

Return type

FileUpload!
id
String!,non-null

Unique File ID

name
String!,non-null

Full file name provided by the user

type
FileType!,non-null

File type corresponds directly with the MIME type (and often the file extension)

uploadUrl
String!,non-null

Signed URL enabling file upload via HTTP PUT with 15-minute expiration

Mutation sample
mutation uploadFile($fileUpload: FileUploadInput) {
  uploadFile(fileUpload: $fileUpload) {
    id 
    name 
    type 
    uploadUrl 
  }
}
Variables
{
  "fileUpload": {
    "name": "Example String",
    "type": "BMP",
    "category": "ORDERS"
  }
}
Response sample
{
  "data": {
    "id": "Example String",
    "name": "Example String",
    "type": "BMP",
    "uploadUrl": "Example String"
  }
}

suggestContacts

(...args)
ContactsSuggestionJob

Suggest products based on those in the contacts prescription

Arguments

contacts
ContactsInput!,non-nullrequired

Contacts details

options
ContactsJobOptionsInput

Contacts job options

tags
[TagInput]

List of tags

Return type

ContactsSuggestionJob
jobId
String

Unique ID for this job

status
String

Current job status

reason
String

Current job reason, if applicable

contacts
Contacts

Contacts details

options
ContactsJobOptions

Contacts options

tags
[Tag]

List of tags used to correlate this workflow with other systems

updatedAt
String!,non-null

Last date and time this job was updated

Mutation sample
mutation suggestContacts(
  $contacts: ContactsInput!
  $options: ContactsJobOptionsInput
  $tags: [TagInput]
) {
  suggestContacts(
    contacts: $contacts
    options: $options
    tags: $tags
  ) {
    jobId 
    status 
    reason 
    contacts {
      products {
        right {
          productId 
          manufacturer 
          brand 
          schedule 
          type 
          diameter 
          baseCurve 
          sphere 
          axis 
          cylinder 
          addition 
          dominance 
          color 
          packageSize 
          quantity 
        }
        left {
          productId 
          manufacturer 
          brand 
          schedule 
          type 
          diameter 
          baseCurve 
          sphere 
          axis 
          cylinder 
          addition 
          dominance 
          color 
          packageSize 
          quantity 
        }
      }
      prescription {
        fileId 
        prescriptionId 
        issueDate 
        expirationDate 
        doctor {
          id 
          doctorName 
          practiceName 
          address 
          city 
          state 
          zipCode 
        }
        patient {
          patientId 
          firstName 
          middleName 
          lastName 
          dateOfBirth 
          phoneNumber 
          email 
          address 
          address2 
          city 
          state 
          zipCode 
          schedulerLink 
        }
        products {
          right {
            productId 
            manufacturer 
            brand 
            schedule 
            type 
            diameter 
            baseCurve 
            sphere 
            axis 
            cylinder 
            addition 
            dominance 
            color 
            packageSize 
            quantity 
          }
          left {
            productId 
            manufacturer 
            brand 
            schedule 
            type 
            diameter 
            baseCurve 
            sphere 
            axis 
            cylinder 
            addition 
            dominance 
            color 
            packageSize 
            quantity 
          }
        }
        comments 
      }
    }
    options {
      contactsSuggestion {
        jobId 
      }
      contactsPrescriptionVerification {
        jobId 
      }
      contactsPrescriptionIssuance {
        jobId 
        sendText 
        sendEmail 
        buyLink 
      }
      contactsFulfillment {
        jobId 
      }
      wait 
    }
    tags {
      name 
      value 
    }
    updatedAt 
  }
}
Variables
{
  "contacts": {
    "products": {
      "right": {
        "productId": "Example String",
        "diameter": "Example String",
        "baseCurve": "Example String",
        "sphere": "Example String",
        "axis": "Example String",
        "cylinder": "Example String",
        "addition": "Example String",
        "dominance": "Example String",
        "color": "Example String",
        "packageSize": 40,
        "quantity": 40
      },
      "left": {
        "productId": "Example String",
        "diameter": "Example String",
        "baseCurve": "Example String",
        "sphere": "Example String",
        "axis": "Example String",
        "cylinder": "Example String",
        "addition": "Example String",
        "dominance": "Example String",
        "color": "Example String",
        "packageSize": 40,
        "quantity": 40
      }
    },
    "prescription": {
      "fileId": "Example String",
      "prescriptionId": "Example String",
      "doctor": {
        "doctorId": "Example String",
        "doctorName": "Example String",
        "practiceName": "Example String",
        "phoneNumber": "Example String",
        "faxNumber": "Example String",
        "email": "Example String",
        "address": "Example String",
        "address2": "Example String",
        "city": "Example String",
        "state": "Example String",
        "zipCode": "Example String",
        "url": "Example String"
      },
      "patient": {
        "patientId": "Example String",
        "firstName": "Example String",
        "middleName": "Example String",
        "lastName": "Example String",
        "dateOfBirth": "Example String",
        "phoneNumber": "Example String",
        "email": "Example String",
        "address": "Example String",
        "address2": "Example String",
        "city": "Example String",
        "state": "Example String",
        "zipCode": "Example String",
        "schedulerLink": "Example String"
      },
      "products": {
        "right": {
          "productId": "Example String",
          "diameter": "Example String",
          "baseCurve": "Example String",
          "sphere": "Example String",
          "axis": "Example String",
          "cylinder": "Example String",
          "addition": "Example String",
          "dominance": "Example String",
          "color": "Example String",
          "packageSize": 40,
          "quantity": 40
        },
        "left": {
          "productId": "Example String",
          "diameter": "Example String",
          "baseCurve": "Example String",
          "sphere": "Example String",
          "axis": "Example String",
          "cylinder": "Example String",
          "addition": "Example String",
          "dominance": "Example String",
          "color": "Example String",
          "packageSize": 40,
          "quantity": 40
        }
      },
      "issueDate": "Example String",
      "expirationDate": "Example String"
    }
  },
  "options": {
    "contactsSuggestion": {
      "jobId": "Example String"
    },
    "contactsPrescriptionVerification": {
      "jobId": "Example String"
    },
    "contactsPrescriptionIssuance": {
      "jobId": "Example String",
      "sendText": true,
      "sendEmail": true,
      "buyLink": true
    },
    "contactsFulfillment": {
      "jobId": "Example String"
    },
    "wait": 40
  },
  "tags": [
    {
      "name": "Example String",
      "value": "Example String"
    }
  ]
}
Response sample
{
  "data": {
    "jobId": "Example String",
    "status": "Example String",
    "reason": "Example String",
    "contacts": {
      "products": [
        {
          "right": {
            "productId": "Example String",
            "manufacturer": "Example String",
            "brand": "Example String",
            "schedule": "Example String",
            "type": "Example String",
            "diameter": "Example String",
            "baseCurve": "Example String",
            "sphere": "Example String",
            "axis": "Example String",
            "cylinder": "Example String",
            "addition": "Example String",
            "dominance": "Example String",
            "color": "Example String",
            "packageSize": 40,
            "quantity": 40
          },
          "left": {
            "productId": "Example String",
            "manufacturer": "Example String",
            "brand": "Example String",
            "schedule": "Example String",
            "type": "Example String",
            "diameter": "Example String",
            "baseCurve": "Example String",
            "sphere": "Example String",
            "axis": "Example String",
            "cylinder": "Example String",
            "addition": "Example String",
            "dominance": "Example String",
            "color": "Example String",
            "packageSize": 40,
            "quantity": 40
          }
        }
      ],
      "prescription": {
        "fileId": "Example String",
        "prescriptionId": "Example String",
        "issueDate": "Example String",
        "expirationDate": "Example String",
        "doctor": {
          "id": "Example String",
          "doctorName": "Example String",
          "practiceName": "Example String",
          "address": "Example String",
          "city": "Example String",
          "state": "Example String",
          "zipCode": "Example String"
        },
        "patient": {
          "patientId": "Example String",
          "firstName": "Example String",
          "middleName": "Example String",
          "lastName": "Example String",
          "dateOfBirth": "Example String",
          "phoneNumber": "Example String",
          "email": "Example String",
          "address": "Example String",
          "address2": "Example String",
          "city": "Example String",
          "state": "Example String",
          "zipCode": "Example String",
          "schedulerLink": "Example String"
        },
        "products": {
          "right": {
            "productId": "Example String",
            "manufacturer": "Example String",
            "brand": "Example String",
            "schedule": "Example String",
            "type": "Example String",
            "diameter": "Example String",
            "baseCurve": "Example String",
            "sphere": "Example String",
            "axis": "Example String",
            "cylinder": "Example String",
            "addition": "Example String",
            "dominance": "Example String",
            "color": "Example String",
            "packageSize": 40,
            "quantity": 40
          },
          "left": {
            "productId": "Example String",
            "manufacturer": "Example String",
            "brand": "Example String",
            "schedule": "Example String",
            "type": "Example String",
            "diameter": "Example String",
            "baseCurve": "Example String",
            "sphere": "Example String",
            "axis": "Example String",
            "cylinder": "Example String",
            "addition": "Example String",
            "dominance": "Example String",
            "color": "Example String",
            "packageSize": 40,
            "quantity": 40
          }
        },
        "comments": "Example String"
      }
    },
    "options": {
      "contactsSuggestion": {
        "jobId": "Example String"
      },
      "contactsPrescriptionVerification": {
        "jobId": "Example String"
      },
      "contactsPrescriptionIssuance": {
        "jobId": "Example String",
        "sendText": true,
        "sendEmail": true,
        "buyLink": true
      },
      "contactsFulfillment": {
        "jobId": "Example String"
      },
      "wait": 40
    },
    "tags": [
      {
        "name": "Example String",
        "value": "Example String"
      }
    ],
    "updatedAt": "Example String"
  }
}

verifyContactsPrescription

(...args)
ContactsPrescriptionVerificationJob

Start a contacts prescription verification job

Arguments

contacts
ContactsInput!,non-nullrequired

Contacts details

options
ContactsJobOptionsInput

Contacts job options

tags
[TagInput]

List of tags

Return type

ContactsPrescriptionVerificationJob
jobId
String

Unique ID for this job

status
String

Current job status

reason
String

Current job reason, if applicable

contacts
Contacts

Contacts details

options
ContactsJobOptions

Contacts options

tags
[Tag]

List of tags used to correlate this workflow with other systems

updatedAt
String!,non-null

Last date and time this job was updated

Mutation sample
mutation verifyContactsPrescription(
  $contacts: ContactsInput!
  $options: ContactsJobOptionsInput
  $tags: [TagInput]
) {
  verifyContactsPrescription(
    contacts: $contacts
    options: $options
    tags: $tags
  ) {
    jobId 
    status 
    reason 
    contacts {
      products {
        right {
          productId 
          manufacturer 
          brand 
          schedule 
          type 
          diameter 
          baseCurve 
          sphere 
          axis 
          cylinder 
          addition 
          dominance 
          color 
          packageSize 
          quantity 
        }
        left {
          productId 
          manufacturer 
          brand 
          schedule 
          type 
          diameter 
          baseCurve 
          sphere 
          axis 
          cylinder 
          addition 
          dominance 
          color 
          packageSize 
          quantity 
        }
      }
      prescription {
        fileId 
        prescriptionId 
        issueDate 
        expirationDate 
        doctor {
          id 
          doctorName 
          practiceName 
          address 
          city 
          state 
          zipCode 
        }
        patient {
          patientId 
          firstName 
          middleName 
          lastName 
          dateOfBirth 
          phoneNumber 
          email 
          address 
          address2 
          city 
          state 
          zipCode 
          schedulerLink 
        }
        products {
          right {
            productId 
            manufacturer 
            brand 
            schedule 
            type 
            diameter 
            baseCurve 
            sphere 
            axis 
            cylinder 
            addition 
            dominance 
            color 
            packageSize 
            quantity 
          }
          left {
            productId 
            manufacturer 
            brand 
            schedule 
            type 
            diameter 
            baseCurve 
            sphere 
            axis 
            cylinder 
            addition 
            dominance 
            color 
            packageSize 
            quantity 
          }
        }
        comments 
      }
    }
    options {
      contactsSuggestion {
        jobId 
      }
      contactsPrescriptionVerification {
        jobId 
      }
      contactsPrescriptionIssuance {
        jobId 
        sendText 
        sendEmail 
        buyLink 
      }
      contactsFulfillment {
        jobId 
      }
      wait 
    }
    tags {
      name 
      value 
    }
    updatedAt 
  }
}
Variables
{
  "contacts": {
    "products": {
      "right": {
        "productId": "Example String",
        "diameter": "Example String",
        "baseCurve": "Example String",
        "sphere": "Example String",
        "axis": "Example String",
        "cylinder": "Example String",
        "addition": "Example String",
        "dominance": "Example String",
        "color": "Example String",
        "packageSize": 40,
        "quantity": 40
      },
      "left": {
        "productId": "Example String",
        "diameter": "Example String",
        "baseCurve": "Example String",
        "sphere": "Example String",
        "axis": "Example String",
        "cylinder": "Example String",
        "addition": "Example String",
        "dominance": "Example String",
        "color": "Example String",
        "packageSize": 40,
        "quantity": 40
      }
    },
    "prescription": {
      "fileId": "Example String",
      "prescriptionId": "Example String",
      "doctor": {
        "doctorId": "Example String",
        "doctorName": "Example String",
        "practiceName": "Example String",
        "phoneNumber": "Example String",
        "faxNumber": "Example String",
        "email": "Example String",
        "address": "Example String",
        "address2": "Example String",
        "city": "Example String",
        "state": "Example String",
        "zipCode": "Example String",
        "url": "Example String"
      },
      "patient": {
        "patientId": "Example String",
        "firstName": "Example String",
        "middleName": "Example String",
        "lastName": "Example String",
        "dateOfBirth": "Example String",
        "phoneNumber": "Example String",
        "email": "Example String",
        "address": "Example String",
        "address2": "Example String",
        "city": "Example String",
        "state": "Example String",
        "zipCode": "Example String",
        "schedulerLink": "Example String"
      },
      "products": {
        "right": {
          "productId": "Example String",
          "diameter": "Example String",
          "baseCurve": "Example String",
          "sphere": "Example String",
          "axis": "Example String",
          "cylinder": "Example String",
          "addition": "Example String",
          "dominance": "Example String",
          "color": "Example String",
          "packageSize": 40,
          "quantity": 40
        },
        "left": {
          "productId": "Example String",
          "diameter": "Example String",
          "baseCurve": "Example String",
          "sphere": "Example String",
          "axis": "Example String",
          "cylinder": "Example String",
          "addition": "Example String",
          "dominance": "Example String",
          "color": "Example String",
          "packageSize": 40,
          "quantity": 40
        }
      },
      "issueDate": "Example String",
      "expirationDate": "Example String"
    }
  },
  "options": {
    "contactsSuggestion": {
      "jobId": "Example String"
    },
    "contactsPrescriptionVerification": {
      "jobId": "Example String"
    },
    "contactsPrescriptionIssuance": {
      "jobId": "Example String",
      "sendText": true,
      "sendEmail": true,
      "buyLink": true
    },
    "contactsFulfillment": {
      "jobId": "Example String"
    },
    "wait": 40
  },
  "tags": [
    {
      "name": "Example String",
      "value": "Example String"
    }
  ]
}
Response sample
{
  "data": {
    "jobId": "Example String",
    "status": "Example String",
    "reason": "Example String",
    "contacts": {
      "products": [
        {
          "right": {
            "productId": "Example String",
            "manufacturer": "Example String",
            "brand": "Example String",
            "schedule": "Example String",
            "type": "Example String",
            "diameter": "Example String",
            "baseCurve": "Example String",
            "sphere": "Example String",
            "axis": "Example String",
            "cylinder": "Example String",
            "addition": "Example String",
            "dominance": "Example String",
            "color": "Example String",
            "packageSize": 40,
            "quantity": 40
          },
          "left": {
            "productId": "Example String",
            "manufacturer": "Example String",
            "brand": "Example String",
            "schedule": "Example String",
            "type": "Example String",
            "diameter": "Example String",
            "baseCurve": "Example String",
            "sphere": "Example String",
            "axis": "Example String",
            "cylinder": "Example String",
            "addition": "Example String",
            "dominance": "Example String",
            "color": "Example String",
            "packageSize": 40,
            "quantity": 40
          }
        }
      ],
      "prescription": {
        "fileId": "Example String",
        "prescriptionId": "Example String",
        "issueDate": "Example String",
        "expirationDate": "Example String",
        "doctor": {
          "id": "Example String",
          "doctorName": "Example String",
          "practiceName": "Example String",
          "address": "Example String",
          "city": "Example String",
          "state": "Example String",
          "zipCode": "Example String"
        },
        "patient": {
          "patientId": "Example String",
          "firstName": "Example String",
          "middleName": "Example String",
          "lastName": "Example String",
          "dateOfBirth": "Example String",
          "phoneNumber": "Example String",
          "email": "Example String",
          "address": "Example String",
          "address2": "Example String",
          "city": "Example String",
          "state": "Example String",
          "zipCode": "Example String",
          "schedulerLink": "Example String"
        },
        "products": {
          "right": {
            "productId": "Example String",
            "manufacturer": "Example String",
            "brand": "Example String",
            "schedule": "Example String",
            "type": "Example String",
            "diameter": "Example String",
            "baseCurve": "Example String",
            "sphere": "Example String",
            "axis": "Example String",
            "cylinder": "Example String",
            "addition": "Example String",
            "dominance": "Example String",
            "color": "Example String",
            "packageSize": 40,
            "quantity": 40
          },
          "left": {
            "productId": "Example String",
            "manufacturer": "Example String",
            "brand": "Example String",
            "schedule": "Example String",
            "type": "Example String",
            "diameter": "Example String",
            "baseCurve": "Example String",
            "sphere": "Example String",
            "axis": "Example String",
            "cylinder": "Example String",
            "addition": "Example String",
            "dominance": "Example String",
            "color": "Example String",
            "packageSize": 40,
            "quantity": 40
          }
        },
        "comments": "Example String"
      }
    },
    "options": {
      "contactsSuggestion": {
        "jobId": "Example String"
      },
      "contactsPrescriptionVerification": {
        "jobId": "Example String"
      },
      "contactsPrescriptionIssuance": {
        "jobId": "Example String",
        "sendText": true,
        "sendEmail": true,
        "buyLink": true
      },
      "contactsFulfillment": {
        "jobId": "Example String"
      },
      "wait": 40
    },
    "tags": [
      {
        "name": "Example String",
        "value": "Example String"
      }
    ],
    "updatedAt": "Example String"
  }
}

Directives

Overview

Objects

Overview

Interfaces

Overview

Enums

Overview

Inputs

Overview