Webhook Variable Reference
Variables available in webhook JSON payloads. Note that this is a work-in-progress guide, as there are more specific variables yet to be added.
How to use this guide
Include any variable token in your webhook message body or URL. The system will substitute the token with the live value at send time. Tokens are lowercase and must include the leading # character (unless used in a url, in that case, they are enclosed in {} with no #.) Note that the system will NOT add quotation marks automatically, so a variable token alone is not a valid JSON string — wrap it yourself when needed.
Dynamic variables (service items and hardware) use a substitution pattern:
#serviceitem{category}{suffix} e.g. #serviceitemvoipname
#hardware{producttype}{suffix} e.g. #hardwareontmacaddress
(you can find more info on available categories and product types in their section.)
In each table, you can search for keywords. You can also click on the highlighted variable to copy it directly to your clipboard.
Quick Links to Sections:
Information about subscribers tied to the workflow.
| Variable | Description | Example Value |
|---|---|---|
| #subscriberfirstname | The subscriber's first name as entered in the system. Returns blank when the subscriber account is classified as a Business type. | James |
| #subscriberlastname | The subscriber's last name as entered in the system. Returns blank when the subscriber account is classified as a Business type. | Bordeux |
| #subscribername | The subscriber's full name (first + last) as a single string. Returns blank when the subscriber account is classified as a Business type. | James Bordeux |
| #subscriberid | Vision's internally generated subscriber ID, following the format SUB-YYMM-XXXXXXXX where YYMM is the year and month of creation. | SUB-2403-00001234 |
| #subscriberuuid | Vision's globally unique identifier (UUID) for the subscriber, guaranteed to be unique across all records and environments. | xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx |
| #subscribercompanyname | The business name tied to the subscriber account. Used for Business-type accounts in place of a personal first/last name. | James Jeans |
| #subscribertype | Indicates whether the subscriber is classified as Residential or Business. Determines which name fields are populated. | Residential |
| #subscriberstatus | The subscriber's current account standing, such as Current, Past Due, or Suspended. | Current |
| #subscriberemailaddress | The first email address on record for the subscriber. If multiple emails are tied to the account, only the primary (first) entry is returned. | james@jamesjeans.com |
| #subscriberphonenumber | The first phone number on record for the subscriber. If multiple numbers are tied to the account, only the primary (first) entry is returned. | 1 (314) 555 0000 |
| #subscriberserviceaddress | The full service address tied to the subscriber's account, including street, suite/unit, city, state, and ZIP+4 where available. | 2101 Burlington St, Ste 101 Columbia, MO 65202-1945 |
| #subscriberbalance | The subscriber's total outstanding account balance, including all current and past due charges. Returned as a decimal value. | 198.90 |
| #subscriberpastduebalance | The portion of the subscriber's balance that is past due only. Does not include charges that are current or not yet due. | 99.95 |
| #subscriberreferralcode | Refferral code associated with the subscriber's account. | XYZC |
| #subscribercheckmdu | A boolean (true/false) indicating whether the subscriber's service address falls within a Multi-Dwelling Unit (MDU) area as defined in the system. | false |
No variables match your search.
| Variable | Description | Example Value |
|---|---|---|
| #locationfulladdress | The complete formatted service address, combining all address lines, city, state, and ZIP+4 into a single string. | 2101 Burlington St, Ste 101 Columbia, MO 65202-1945 |
| #locationaddress1 | The primary street address line (street number and name) of the service location. | 2101 Burlington St |
| #locationaddress2 | The secondary address line (e.g., suite, apartment, or unit number). Returns blank if no second line is recorded. | Ste 101 |
| #locationaddress3 | A third address line for locations requiring additional detail. Returns blank if not used. | |
| #locationcity | The city portion of the service location's address. | Columbia |
| #locationstate | The two-character abbreviated state code for the service location (USPS standard abbreviation). | MO |
| #locationzip | The five-digit ZIP code for the service location. | 65202 |
| #locationzip4 | The four-digit ZIP+4 extension for the service location, providing more precise delivery routing. Returns blank if no ZIP+4 is on record. | 1945 |
| #locationcounty | The county in which the service location resides. | Boone |
| #locationcountrycode | The two-character ISO 3166-1 alpha-2 country code for the service location. | US |
| #locationlatitude | The latitude coordinate of the service location, stored with up to 10 decimal places of precision. Note: USPS-verified addresses are accurate to 7 decimal places. | 38.9723955000 |
| #locationlongitude | The longitude coordinate of the service location, stored with up to 10 decimal places of precision. Note: USPS-verified addresses are accurate to 7 decimal places. | -92.3098743000 |
| #locationgeopoint | The location's coordinates expressed as a WKT POINT tuple (longitude latitude) with up to 10 decimal places. Note: currently marked as broken in the source data. | POINT(38.6008253 -90.2507186) |
| #locationelevation | The elevation of the service location above sea level, in meters. May return 0.0000 if elevation data has not been captured. | 0.0000 |
| #locationcensusblock | The U.S. Census Bureau block number for the service location, used for demographic and reporting purposes. | 2017 |
| #locationcensustract | The U.S. Census Bureau tract number for the service location, used for demographic reporting and federal program qualification. | 29019001507 |
No variables match your search.
| Variable | Description | Example Value |
|---|---|---|
| #packagename | The display name of the subscriber's active service package as configured in Vision. | 1Gbps Fiber Internet |
| #packageactive | Indicates whether the package is currently active. Returns 1 for active, 0 for inactive. | 1 |
| #packageadvertiseddown | The advertised (marketed) download speed of the package, in Mbps. | 1000 |
| #packageadvertisedup | The advertised (marketed) upload speed of the package, in Mbps. | 1000 |
| #packageprovisioneddown | The actual provisioned download speed assigned to the subscriber's connection, in Mbps. May differ from advertised speed. | 1000 |
| #packageprovisionedup | The actual provisioned upload speed assigned to the subscriber's connection, in Mbps. May differ from advertised speed. | 1000 |
| #packagebilldate | The billing cycle date for the package, formatted as YYYY-MM-DD. | 2026-05-01 |
| #packageterm | The contract term length for the package, expressed in months. | 1 |
| #packageipaddress | The IP address currently assigned to the subscriber's package. | 100.66.16.3 |
| #packageipaddressestotal | The total count of IP addresses assigned to the subscriber's package. | 8 |
| #packageipassignmentdate | The date and time the current IP address was assigned to the package, in YYYY-MM-DD HH:MM:SS format. | 2026-04-10 09:21:58 |
| #packageipbits | The prefix length (CIDR notation host bits) of the IP assignment, indicating the subnet size. | 8 |
| #packageipisv6 | Indicates whether the assigned IP address is IPv6. Returns 1 for IPv6, 0 for IPv4. | 0 |
| #packageipprefix | The CIDR prefix notation of the IP subnet assigned to this package (e.g., /24). | /24 |
| #packageipsubnetmask | The subnet mask associated with the package's IP assignment, in dotted-decimal notation. | 255.255.255.0 |
No variables match your search.
This section uses the following circuit as an example:
| Variable | Description | Example Value |
|---|---|---|
| #circuitparentid | Vision's unique identifier for the parent circuit, formatted as CIR-YYMM-XXXXXXXXXX. | CIR-2603-0000166478 |
| #circuitparentstatus | The current lifecycle status of the parent circuit (e.g., Initial, Final, Out of Service). | Final |
| #circuitparenttype | The classification type of the parent circuit. Typically 'Last Mile' for subscriber-facing circuits. | Last Mile |
| #circuitparentdatecreated | The date and time the parent circuit record was created in Vision, in ISO 8601 format with timezone offset. | 2026-03-18T15:55:02-05:00 |
No variables match your search.
This section uses the following circuit as an example:
| Variable | Description | Example Value |
|---|---|---|
| #circuitasideid | Vision's unique ID for the A-side vendor circuit. | CIR-2603-0000166474 |
| #circuitasidedescription | A human-readable label describing the A-side circuit's route or role in the network. | JOE OLT to Splitter PON 2 |
| #circuitasidestatus | The current operational status of the A-side vendor circuit. | In Service |
| #circuitasidepoid | The purchase order ID in Vision that brought the A-side vendor circuit into the system. | PUR-2603-00196 |
| #circuitasidemodel | The circuit model or type as classified in Vision (e.g., Fiber Circuit, Ethernet Circuit). | Fiber Circuit |
| #circuitasideaaddress | The full civic address of the hardware located at the A endpoint of Vendor Circuit A. | 4271 Northeast Dr Tower St. Louis, MO 63110-0000 |
| #circuitasidealatitude | The latitude of the hardware at the A endpoint of Vendor Circuit A. | 38.6077806000 |
| #circuitasidealongitude | The longitude of the hardware at the A endpoint of Vendor Circuit A. | 92.3278246000 |
| #circuitasidezaddress | The full civic address of the hardware located at the Z endpoint of Vendor Circuit A. | 4360 Northwest Dr Tower St. Louis, MO 63110-0000 |
| #circuitasidezlatitude | The latitude of the hardware at the Z endpoint of Vendor Circuit A. | 38.6078904000 |
| #circuitasidezlongitude | The longitude of the hardware at the Z endpoint of Vendor Circuit A. | -90.2598221000 |
| #circuitasideaportid | Vision's hardware record ID for the device hosting the A-side port of Vendor Circuit A. | HDW-2603-10689 |
| #circuitasideaporthostname | The hostname assigned to the hardware device at the A-side port of Vendor Circuit A. | Fibersmith Vision Demo HDW-2603-10689 |
| #circuitasideaportmacaddress | The MAC address of the hardware device hosting the A-side port. | 12:12:12:12:12:12 |
| #circuitasideaportmanufacturer | The manufacturer of the hardware device at the A-side port. | Ubiquiti |
| #circuitasideaportmodel | The model name of the hardware device at the A-side port. | UFiber OLT 4 |
| #circuitasideaportmodeldescription | The extended model description or full product name for the A-side port hardware, as stored in Vision. | Ubiquiti UFiber OLT 4 |
| #circuitasideaportlabel | The human-readable port label as configured on the A-side hardware device. | GPON 2 |
| #circuitasideaportnumber | The numeric port number on the A-side hardware device that this circuit connects to. | 2 |
| #circuitasideaporttype | The port type or technology standard used at the A-side port (e.g., GPON, Ethernet - GigE). | GPON |
| #circuitasideaportproducttype | The internal product type ID assigned to the A-side port's hardware in Vision. | 26 |
| #circuitasideaportserialnumber | The serial number of the hardware device at the A-side port, as recorded in Vision. | UBNT1234 |
| #circuitasideaportvendorname | The vendor or supplier name associated with the A-side port's hardware record. | Placeholders Vendor |
| #circuitasideaportreferralcode | The referral or tracking code tied to the A-side port hardware record. | X6WS |
| #circuitasideaportmovable | Indicates whether the A-side port assignment can be moved to a different hardware device. Returns 1 for movable, 0 for fixed. | 1 |
| #circuitasideaportipaddress | The IP address assigned to the A-side port hardware, if applicable. | |
| #circuitasideaportgeopoint | The geographic coordinates of the A-side port hardware expressed as a WKT POINT tuple (longitude latitude). | POINT(38.6077806 -90.2571568) |
| #circuitasideaportlatitude | The latitude coordinate of the A-side port's physical hardware location. | 38.6077806000 |
| #circuitasideaportlongitude | The longitude coordinate of the A-side port's physical hardware location. | -90.2571568000 |
| #circuitasideaportelevation | The elevation of the A-side port's physical hardware location, in meters. | 0.0000000000 |
| #circuitasideaportaddress | The full civic address of the A-side port's hardware location. | 4271 Northeast Dr Tower St. Louis, MO 63110-0000 |
| #circuitasideaportaddress1 | Street number and name of the A-side port hardware's address. | 4271 Northeast Dr |
| #circuitasideaportaddress2 | Suite, floor, or secondary address line for the A-side port hardware. Returns blank if not applicable. | Tower |
| #circuitasideaportaddress3 | Third address line for the A-side port hardware. Returns blank if not applicable. | |
| #circuitasideaportcity | The city of the A-side port hardware's address. | St. Louis |
| #circuitasideaportstate | The two-character state abbreviation of the A-side port hardware's address. | MO |
| #circuitasideaportzip | The five-digit ZIP code of the A-side port hardware's address. | 63110 |
| #circuitasideaportzip4 | The ZIP+4 extension of the A-side port hardware's address. Returns blank if not available. | 0000 |
| #circuitasideaportcounty | The county of the A-side port hardware's address. | St. Louis City |
| #circuitasideaportcountrycode | The two-character ISO country code of the A-side port hardware's address. | US |
| #circuitasideaportcensusblock | The U.S. Census block identifier for the A-side port hardware's address. | 1000 |
| #circuitasideaportcensustract | The U.S. Census tract identifier for the A-side port hardware's address. | 29510116200 |
| #circuitasideaportdescription | A descriptive label for the A-side port as configured in Vision. | Joe-OLT UFiber |
| #circuitasideaportindex | The zero-based or one-based index of the A-side port on its host hardware device. | 2 |
| #circuitasidezportid | Vision's hardware record ID for the device hosting the Z-side port of Vendor Circuit A. | HDW-2603-10691 |
| #circuitasidezporthostname | The hostname of the hardware device at the Z-side port of Vendor Circuit A. | Fibersmith Vision Demo HDW-2603-10691 |
| #circuitasidezportmacaddress | The MAC address of the hardware device at the Z-side port of Vendor Circuit A. Returns blank if not recorded. | |
| #circuitasidezportmanufacturer | The manufacturer of the hardware device at the Z-side port. | Placeholders Manufacturer |
| #circuitasidezportmodel | The model name of the hardware device at the Z-side port. | FPH 1x32 Splitter |
| #circuitasidezportmodeldescription | The extended model description or full product name for the Z-side port hardware, as stored in Vision. | Placeholder for 1x32 Fiber Splitter |
| #circuitasidezportlabel | The human-readable port label as configured on the Z-side hardware device. | Generic INPUT 1 |
| #circuitasidezportnumber | The numeric port number on the Z-side hardware device that this circuit connects to. | 1 |
| #circuitasidezporttype | The port type or technology standard used at the Z-side port. | Generic INPUT |
| #circuitasidezportproducttype | The internal product type ID assigned to the Z-side port's hardware in Vision. | 29 |
| #circuitasidezportserialnumber | The serial number of the hardware device at the Z-side port. Returns blank if not recorded. | |
| #circuitasidezportvendorname | The vendor or supplier name associated with the Z-side port's hardware record. | Placeholders Vendor |
| #circuitasidezportreferralcode | The referral or tracking code tied to the Z-side port hardware record. | Y28E |
| #circuitasidezportmovable | Indicates whether the Z-side port assignment can be moved to a different device. Returns 1 for movable, 0 for fixed. | 1 |
| #circuitasidezportipaddress | The IP address assigned to the Z-side port hardware, if applicable. | |
| #circuitasidezportgeopoint | The geographic coordinates of the Z-side port hardware expressed as a WKT POINT tuple (longitude latitude). | POINT(38.6078904 -90.2598221) |
| #circuitasidezportlatitude | The latitude coordinate of the Z-side port's physical hardware location. | 38.6078904000 |
| #circuitasidezportlongitude | The longitude coordinate of the Z-side port's physical hardware location. | -90.2598221000 |
| #circuitasidezportelevation | The elevation of the Z-side port's physical hardware location, in meters. | 0.0000000000 |
| #circuitasidezportaddress | The full civic address of the Z-side port's hardware location. | 4271 Northeast Dr Tower St. Louis, MO 63110-0000 |
| #circuitasidezportaddress1 | Street number and name of the Z-side port hardware's address. | 4271 Northeast Dr |
| #circuitasidezportaddress2 | Suite, floor, or secondary address line for the Z-side port hardware. Returns blank if not applicable. | Tower |
| #circuitasidezportaddress3 | Third address line for the Z-side port hardware. Returns blank if not applicable. | |
| #circuitasidezportcity | The city of the Z-side port hardware's address. | St. Louis |
| #circuitasidezportstate | The two-character state abbreviation of the Z-side port hardware's address. | MO |
| #circuitasidezportzip | The five-digit ZIP code of the Z-side port hardware's address. | 63110 |
| #circuitasidezportzip4 | The ZIP+4 extension of the Z-side port hardware's address. Returns blank if not available. | 0000 |
| #circuitasidezportcounty | The county of the Z-side port hardware's address. | Saint Louis City |
| #circuitasidezportcountrycode | The two-character ISO country code of the Z-side port hardware's address. | US |
| #circuitasidezportcensusblock | The U.S. Census block identifier for the Z-side port hardware's address. | 1000 |
| #circuitasidezportcensustract | The U.S. Census tract identifier for the Z-side port hardware's address. | 29510116200 |
| #circuitasidezportdescription | A descriptive label for the Z-side port as configured in Vision. | Joe-OLT PON2 |
| #circuitasidezportindex | The zero-based or one-based index of the Z-side port on its host hardware device. | 1 |
No variables match your search.
This section uses the following circuit as an example:
| Variable | Description | Example Value |
|---|---|---|
| #circuitzsideid | Vision's unique ID for the Z-side vendor circuit (the customer premises endpoint). | CIR-2604-0000166482 |
| #circuitzsidedescription | A human-readable description of the Z-side circuit, typically describing the drop type or CPE connection. | CPE Ethernet Drop |
| #circuitzsidestatus | The current operational status of the Z-side vendor circuit. | In Service |
| #circuitzsidepoid | The purchase order ID in Vision that brought the Z-side vendor circuit into the system. | PUR-1902-00023 |
| #circuitzsidemodel | The circuit model or type as classified in Vision for the Z-side. | Ethernet Circuit |
| #circuitzsideaaddress | The full civic address of the hardware at the A endpoint of the Z-side vendor circuit. | 3917 Connecticut St Saint Louis, MO 63116-3905 |
| #circuitzsidealatitude | The latitude of the hardware at the A endpoint of the Z-side vendor circuit. | 38.6008205000 |
| #circuitzsidealongitude | The longitude of the hardware at the A endpoint of the Z-side vendor circuit. | -90.2507098000 |
| #circuitzsidezaddress | The full civic address of the hardware at the Z endpoint of the Z-side vendor circuit. | 3917 Connecticut St Saint Louis, MO 63116-3905 |
| #circuitzsidezlatitude | The latitude of the hardware at the Z endpoint of the Z-side vendor circuit. | 38.6008205000 |
| #circuitzsidezlongitude | The longitude of the hardware at the Z endpoint of the Z-side vendor circuit. | -90.2507098000 |
| #circuitzsideaportid | Vision's hardware record ID for the device at the A-side port of the Z-side circuit. | HDW-2512-10644 |
| #circuitzsideaporthostname | The hostname of the hardware device at the A-side port of the Z-side circuit. | Fibersmith Vision Demo HDW-2512-10644 |
| #circuitzsideaportmacaddress | The MAC address of the hardware device at the A-side port of the Z-side circuit. | 03:d3:e3:5b:e3:b1 |
| #circuitzsideaportmanufacturer | The manufacturer of the hardware device at the A-side port of the Z-side circuit. | Ubiquiti |
| #circuitzsideaportmodel | The model name of the hardware device at the A-side port of the Z-side circuit. | UFiber Loco |
| #circuitzsideaportmodeldescription | The extended model description or full product name for the A-side port hardware in the Z-side circuit. | Ubiquiti UFiber Loco |
| #circuitzsideaportlabel | The human-readable port label on the A-side hardware of the Z-side circuit. | Ethernet - GigE 1 |
| #circuitzsideaportnumber | The numeric port number on the A-side hardware device of the Z-side circuit. | 1 |
| #circuitzsideaporttype | The port type or technology at the A-side port of the Z-side circuit. | Ethernet - GigE |
| #circuitzsideaportproducttype | The internal product type ID of the A-side port hardware in the Z-side circuit. | 7 |
| #circuitzsideaportserialnumber | The serial number of the A-side port hardware in the Z-side circuit. | TEST-12345 |
| #circuitzsideaportvendorname | The vendor name associated with the A-side port hardware in the Z-side circuit. | Placeholders Vendor |
| #circuitzsideaportreferralcode | The referral or tracking code for the A-side port hardware in the Z-side circuit. | MZDV |
| #circuitzsideaportmovable | Indicates whether the A-side port in the Z-side circuit can be reassigned. Returns 1 for movable, 0 for fixed. | 1 |
| #circuitzsideaportipaddress | The IP address assigned to the A-side port hardware in the Z-side circuit, if applicable. | |
| #circuitzsideaportgeopoint | The geographic coordinates of the A-side port hardware expressed as a WKT POINT tuple (longitude latitude). | POINT(38.6008253 -90.2507186) |
| #circuitzsideaportlatitude | The latitude of the A-side port hardware's physical location in the Z-side circuit. | -90.2507098000 |
| #circuitzsideaportlongitude | The longitude of the A-side port hardware's physical location in the Z-side circuit. | 0.0000000000 |
| #circuitzsideaportelevation | The elevation of the A-side port hardware's location in the Z-side circuit, in meters. | 3917 Connecticut St Saint Louis, MO 63116-3905 |
| #circuitzsideaportaddress | The full civic address of the A-side port hardware in the Z-side circuit. | 3917 Connecticut St |
| #circuitzsideaportaddress1 | Street number and name of the A-side port hardware address in the Z-side circuit. | |
| #circuitzsideaportaddress2 | Secondary address line for the A-side port hardware in the Z-side circuit. Returns blank if not applicable. | |
| #circuitzsideaportaddress3 | Third address line for the A-side port hardware in the Z-side circuit. Returns blank if not applicable. | |
| #circuitzsideaportcity | The city of the A-side port hardware's address in the Z-side circuit. | Saint Louis |
| #circuitzsideaportstate | The two-character state abbreviation for the A-side port hardware in the Z-side circuit. | MO |
| #circuitzsideaportzip | The five-digit ZIP code for the A-side port hardware in the Z-side circuit. | 63116 |
| #circuitzsideaportzip4 | The ZIP+4 extension for the A-side port hardware in the Z-side circuit. Returns blank if not available. | 3905 |
| #circuitzsideaportcounty | The county for the A-side port hardware in the Z-side circuit. | Saint Louis City |
| #circuitzsideaportcountrycode | The two-character ISO country code for the A-side port hardware in the Z-side circuit. | US |
| #circuitzsideaportcensusblock | The U.S. Census block identifier for the A-side port hardware in the Z-side circuit. | 2003 |
| #circuitzsideaportcensustract | The U.S. Census tract identifier for the A-side port hardware in the Z-side circuit. | 29510116200 |
| #circuitzsideaportdescription | A descriptive label for the A-side port in the Z-side circuit as configured in Vision. | UFiber Loco |
| #circuitzsideaportindex | The port index of the A-side port on its host hardware device in the Z-side circuit. | 2 |
| #circuitzsidezportid | Vision's hardware record ID for the CPE device at the Z-side port of the Z-side circuit. | HDW-2602-10676 |
| #circuitzsidezporthostname | The hostname of the CPE device at the Z-side port of the Z-side circuit. | Fibersmith Vision Demo HDW-2602-10676 |
| #circuitzsidezportmacaddress | The MAC address of the CPE device at the Z-side port. | 02:E8:61:4F:9C:3A |
| #circuitzsidezportmanufacturer | The manufacturer of the CPE device at the Z-side port. | TP-Link |
| #circuitzsidezportmodel | The model name of the CPE device at the Z-side port. | HX510-PoE |
| #circuitzsidezportmodeldescription | The extended model description or full product name for the Z-side CPE hardware in the Z-side circuit. | |
| #circuitzsidezportlabel | The human-readable port label on the CPE device at the Z-side port. | Ethernet - POE 1 |
| #circuitzsidezportnumber | The numeric port number on the CPE device at the Z-side port. | 1 |
| #circuitzsidezporttype | The port type or technology at the Z-side port of the Z-side circuit. | Ethernet - POE |
| #circuitzsidezportproducttype | The internal product type ID of the Z-side port hardware. | 1 |
| #circuitzsidezportserialnumber | The serial number of the Z-side port hardware device. | 8FQ2M7K9A4TL |
| #circuitzsidezportvendorname | The vendor name associated with the Z-side port hardware record. | Placeholders Vendor |
| #circuitzsidezportreferralcode | The referral or tracking code for the Z-side port hardware record. | QUS1 |
| #circuitzsidezportmovable | Indicates whether the Z-side port can be reassigned to a different device. Returns 1 for movable, 0 for fixed. | 1 |
| #circuitzsidezportipaddress | The IP address assigned to the Z-side CPE port, if applicable. | |
| #circuitzsidezportgeopoint | The geographic coordinates of the Z-side CPE hardware expressed as a WKT POINT tuple (longitude latitude). | POINT(38.6008253 -90.2507186) |
| #circuitzsidezportlatitude | The latitude of the Z-side port hardware's physical location. | 38.6008205000 |
| #circuitzsidezportlongitude | The longitude of the Z-side port hardware's physical location. | -90.2507098000 |
| #circuitzsidezportelevation | The elevation of the Z-side port hardware's location, in meters. | 0.0000000000 |
| #circuitzsidezportaddress | The full civic address of the Z-side port hardware's location. | 3917 Connecticut St Saint Louis, MO 63116-3905 |
| #circuitzsidezportaddress1 | Street number and name of the Z-side port hardware's address. | 3917 Connecticut St |
| #circuitzsidezportaddress2 | Secondary address line for the Z-side port hardware. Returns blank if not applicable. | |
| #circuitzsidezportaddress3 | Third address line for the Z-side port hardware. Returns blank if not applicable. | |
| #circuitzsidezportcity | The city of the Z-side port hardware's address. | Saint Louis |
| #circuitzsidezportstate | The two-character state abbreviation for the Z-side port hardware's address. | MO |
| #circuitzsidezportzip | The five-digit ZIP code for the Z-side port hardware's address. | 63116 |
| #circuitzsidezportzip4 | The ZIP+4 extension of the Z-side port hardware's address. Returns blank if not available. | 3905 |
| #circuitzsidezportcounty | The county for the Z-side port hardware's address. | Saint Louis City |
| #circuitzsidezportcountrycode | The two-character ISO country code for the Z-side port hardware's address. | US |
| #circuitzsidezportcensusblock | The U.S. Census block identifier for the Z-side port hardware's address. | 2003 |
| #circuitzsidezportcensustract | The U.S. Census tract identifier for the Z-side port hardware's address. | 29510116200 |
| #circuitzsidezportdescription | A descriptive label for the Z-side port as configured in Vision. | UFiber Loco |
| #circuitzsidezportindex | The port index of the Z-side port on its host hardware device. | 1 |
No variables match your search.
To use these variables, replace {category} with the exact category name (all lowercase, no spaces).
Here is a list of current service item categories. Note that the package this webhook is tied to would need a service item of one of these categories to substitute. Also note that if there are multiple of one category, currently, the variable will only substitute the first item.
Available categories:
|
|
The following table uses this service item as an example (note that ont replaced {category} in this instance)
| Variable | Description | Example Value |
|---|---|---|
| #serviceitem{category}active | Indicates whether the service item is currently active on the subscriber's account. Returns 1 for active, 0 for inactive. | 1 |
| #serviceitem{category}activedate | The date the service item became active on the subscriber's account, formatted as YYYY-MM-DD. | 2026-03-18 00:00:00 |
| #serviceitem{category}billdate | The next billing date for this service item, formatted as YYYY-MM-DD. | 2026-03-18 |
| #serviceitem{category}category | The category name of the service item as defined in Vision (matches the {category} token used in the variable). | ONT |
| #serviceitem{category}description | The full description of the service item as configured in Vision. | Optical Network Unit |
| #serviceitem{category}name | The short display name of the service item. | ONU |
| #serviceitem{category}price | The price of the service item on the subscriber's account, expressed as a decimal value. | 0.00000 |
| #serviceitem{category}ipaddress | The IP address assigned to this service item, if applicable. | 100.66.16.3 |
| #serviceitem{category}ipaddressestotal | The total count of IP addresses assigned to this service item. | |
| #serviceitem{category}ipbits | The CIDR prefix length of the IP assignment for this service item. Returns blank if no IP is assigned. | |
| #serviceitem{category}itemipisv6 | Indicates whether the service item's IP address is IPv6. Returns 1 for IPv6, 0 for IPv4. Returns blank if no IP is assigned. | |
| #serviceitem{category}ipprefix | The CIDR prefix notation of the IP subnet for this service item (e.g., /29). Returns blank if no IP is assigned. | |
| #serviceitem{category}ipsubnetmask | The subnet mask for the service item's IP assignment in dotted-decimal notation. Returns blank if no IP is assigned. | |
| #serviceitem{category}phonenumber | The phone number tied to this service item, applicable to Phone-category items. Returns blank if no number is assigned. |
No variables match your search.
To use these variables, replace {producttype} with the exact hardware's product type name (all lowercase, no spaces).
Here is a list of current product types. Note that the package this webhook is tied to would need a service item tied with one of these products. Also note that if there are multiple of one category, currently, the variable will only substitute the first item.
Available product types:
|
|
The following table uses this ONT as an example (note that ont replaced {producttype} in this instance)
| Variable | Description | Example Value |
|---|---|---|
| #hardware{producttype}id | Vision's unique hardware record ID for the device, formatted as HDW-YYMM-XXXXX. | HDW-2512-10644 |
| #hardware{producttype}ipaddress | The IP address currently assigned to the hardware device. | 100.66.16.3 |
| #hardware{producttype}ipaddressestotal | The total count of IP addresses assigned to this hardware device. | 8 |
| #hardware{producttype}ipassignmentdate | The date and time the current IP address was assigned to this hardware device, in YYYY-MM-DD HH:MM:SS format. | 2026-05-21 17:05:18 |
| #hardware{producttype}ipbits | The CIDR prefix length of the IP assignment for this hardware device. | 3 |
| #hardware{producttype}ipisv6 | Indicates whether the hardware device's IP address is IPv6. Returns 1 for IPv6, 0 for IPv4. | 0 |
| #hardware{producttype}ipprefix | The CIDR prefix notation of the IP subnet assigned to this hardware device. | /29 |
| #hardware{producttype}macaddress | The MAC address of the hardware device as recorded in Vision. | 03:d3:e3:5b:e3:b1 |
| #hardware{producttype}manufacturername | The name of the hardware device's manufacturer. | Ubiquiti |
| #hardware{producttype}model | The hardware model name or identifier as classified in Vision. | UFiber Loco |
| #hardware{producttype}modeldescription | The extended model description or full product name for this hardware device. | UFiber Loco |
| #hardware{producttype}monitor | The name of the monitoring integration or profile assigned to this hardware device (e.g., Zabbix template). | Zabbix-Olt-Ont Hybrid |
| #hardware{producttype}monitoringenabled | Indicates whether active monitoring is enabled for this hardware device. Returns 1 for enabled, 0 for disabled. | Not Monitored |
| #hardware{producttype}monitoringhostname | The hostname used by the monitoring system (e.g., Zabbix) to identify and poll this hardware device. | Fibersmith Vision Demo HDW-2512-10644 |
| #hardware{producttype}producttype | The product type classification of the hardware device in Vision (matches the {producttype} token used in the variable). | ONT |
| #hardware{producttype}referralcode | The referral or tracking code tied to this hardware device's record. | MZDV |
| #hardware{producttype}serialnumber | The serial number of the hardware device as recorded in Vision. | TEST-12345 |
| #hardware{producttype}cleicode | The Common Language Equipment Identifier (CLEI) code for the hardware device, used for telecom equipment inventory. Returns blank if not applicable. | |
| #hardware{producttype}vendorname | The vendor or supplier name associated with this hardware device's record in Vision. | Placeholders Vendor |
| #hardware{producttype}description | A human-readable description or label for the hardware device as configured in Vision. | UFiber Loco |
| #hardware{producttype}legacyserviceid | A legacy service identifier for the hardware device, used when migrating records from older systems. Returns blank if no legacy ID is mapped. |
No variables match your search.
| Variable | Description | Example Value |
|---|---|---|
| #wfpid | Vision's internally generated workflow process ID, following the format WFP-YYMM-XXXXXXXX where YYMM is the year and month of creation. | WFP-2605-0000001 |
| #wfpuuid | Vision's globally unique identifier (UUID) for the workflow process, guaranteed to be unique across all records and environments. | xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx |
| #taskuuid | Vision's globally unique identifier (UUID) for the current task, guaranteed to be unique across all records and environments. | xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx |
| #ticketid | Vision's internally generated ticket ID, following the format TIC-YYMM-XXXXXXXX where YYMM is the year and month of creation. | TIC-2605-000001 |
| #ticketuuid | Vision's globally unique identifier (UUID) for the ticket, guaranteed to be unique across all records and environments. | xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx |
| #parenttask() | Allows you to query, using JMESPath notation, the Parent's tasks webhook's response object | |
| #hmac() | An HMAC (Hash-based Message Authentication Code) signature generated from the webhook payload and your shared secret. Use this to verify that the request originated from Vision and has not been tampered with. Requires the algorithm, secret key ID, and message ID to be passed: #hmac(sha256, secretkeyid, messageid) | 14a2715d35b254070cb215ebb7013ed988d382945c2b36ddb5991214ef79c796 |
| #blowfish() | A Blowfish-encrypted token for payload verification. Can be used as an alternative authentication mechanism when the receiving endpoint supports Blowfish decryption. Requires a password to encrypt, passed like: #blowfish(password) | $2y$07$69g8uSJ4z5OtTSca5zWUnO9PGN7PdbosArw1Xpy/4G31qFfWf2fAu |
| #timestamp | A POSIX (Unix) timestamp indicating the exact moment the webhook was dispatched, expressed as the number of seconds elapsed since January 1, 1970 (UTC). Use this for replay-attack prevention and time-based validation. | 1776699027 |
No variables match your search.