Currently Available
Delivery Method(s): Web Hook, Inline Email, Email attachment
Released: 8/23/22
Effective: 8/1/22
Updated: 8/7/26
XML format is a computer readable format that works great with inserting the ticket data into a database or ticket management system but is not at all human readable. XML is available via REST Web hook or via email delivery.
The XML format contains all the fields of the current plain text format plus all of the additional lat/long coordinates for the actual location of the job site. For a complete list of fields please make sure to see the current plain text documentation.
What is a Web Hook?
A web hook is an Application Programming Interface (API) that servers use to make a connection to a remote server and pass either commands or data. Our web hook will connect to your servers and deliver the ticket data when the ticket is issued.
NOTE
We recommend members use JSON for web hooks unless they are currently using XML already.
What are the requirements to use the Web Hook?
-
The member receiving the ticket must set up an API endpoint that will accept a request from DigAlert's® servers with the "Content-Type: text/xml" allowed
-
The length of the URL for the API endpoint (not including the http:// or https://) must not exceed 128 characters
-
The API endpoint MUST provide a response within 3 seconds, otherwise the request will be treated as failed and will be retried again
-
In order for the DigAlert® ticket, message, end of day, etc to be marked as received by the API endpoint (delivered), it MUST return a 200 level HTTP status code. All other codes or incomplete responses will be treated as failed and will be retried again.
-
The response should follow HTTP specification RFC 2616 and must be in the following format "HTTP/1.1 SSS description CR-LF" where SSS is the 3 digit status code and CF-LF is a line break consisting of the ASCII carriage return and line dees characters. There is no white space before the "CR-LF" but it is shown that way for readability only in this documentation.
-
After the status line any headers should be sent. If no headers are sent another CR-LF must be sent after the status line. The headers must end with two CR-LF pairs.
-
A response body is not required. However, if there is an error in the receiving API. it should send back an error message either as plain text or as a XML object with a “message” property. Alternatively, a custom description can be used following the status code on the first response line.
-
For plain text, there should be a header of “Content-Type: text/plain” or no content-type header
-
For XML, there must be a header of “Content-Type: text/xml”
-
What are the differences between inline email and email attachments?
Inline emails displays the text (XML) within the body of the email directly and the email doesn't contain any attachments. Whereas with email attachments the body of the email is empty and the email will show an attachment.
WARNING
Not all fields shown below are sent on every ticket.
To ensure your system process the ticket correctly, program the input parser to parse fields IF they appear in the data set sent. Some fields will not be sent under certain conditions and also doing this future proofs your system if the center ever were to remove fields from the output ticket format.
XML Samples
NOTE
Broadcast messages deliver as plain text for XML format users.
NEW Ticket
XML
<?xml version="1.0"?>
<NewDataSet>
<delivery>
<format_version>1.05.01.8</format_version>
<center>USASA</center>
<recipient>MBRCD01</recipient>
<transmission_type>TKT</transmission_type>
<transmitted>2024-03-28T22:42:02</transmitted>
<seq_num>6</seq_num>
<ticket>A121231234</ticket>
<revision>00A</revision>
</delivery>
<tickets>
<ticket>A121231234</ticket>
<revision>00A</revision>
<created>2026-07-24T05:39:52-07:00</created>
<account>CSR01</account>
<channel>200</channel>
<work_date>2026-07-29T17:01:00-07:00</work_date>
<response_required>Y</response_required>
<response_due>2026-07-29T17:01:00-07:00</response_due>
<replace_by_date>2026-08-21T23:59:59-07:00</replace_by_date>
<expires>2026-08-21T23:59:59-07:00</expires>
<one_year>N</one_year>
<priority>NORM</priority>
<type>NEW</type>
<category>LREQ</category>
<lookup>POLY</lookup>
<state>CA</state>
<county>LOS ANGELES</county>
<place>CARSON</place>
<work_area_zip_codes>12345</work_area_zip_codes>
<street>MAIN ST</street>
<cross1>1ST ST</cross1>
<cross2>2ND ST</cross2>
<caller_gps>
<coordinate>
<latitude>12.123456</latitude>
<longitude>-123.123456</longitude>
</coordinate>
</caller_gps>
<polygon>
<coordinate>
<latitude>12.123456</latitude>
<longitude>-123.123456</longitude>
</coordinate>
<coordinate>
<latitude>12.123456</latitude>
<longitude>-123.123456</longitude>
</coordinate>
<coordinate>
<latitude>12.123456</latitude>
<longitude>-123.123456</longitude>
</coordinate>
<coordinate>
<latitude>12.123456</latitude>
<longitude>-123.123456</longitude>
</coordinate>
<coordinate>
<latitude>12.123456</latitude>
<longitude>-123.123456</longitude>
</coordinate>
<coordinate>
<latitude>12.123456</latitude>
<longitude>-123.123456</longitude>
</coordinate>
<coordinate>
<latitude>12.123456</latitude>
<longitude>-123.123456</longitude>
</coordinate>
<coordinate>
<latitude>12.123456</latitude>
<longitude>-123.123456</longitude>
</coordinate>
<coordinate>
<latitude>12.123456</latitude>
<longitude>-123.123456</longitude>
</coordinate>
<coordinate>
<latitude>12.123456</latitude>
<longitude>-123.123456</longitude>
</coordinate>
<coordinate>
<latitude>12.123456</latitude>
<longitude>-123.123456</longitude>
</coordinate>
<coordinate>
<latitude>12.123456</latitude>
<longitude>-123.123456</longitude>
</coordinate>
<coordinate>
<latitude>12.123456</latitude>
<longitude>-123.123456</longitude>
</coordinate>
<coordinate>
<latitude>12.123456</latitude>
<longitude>-123.123456</longitude>
</coordinate>
<coordinate>
<latitude>12.123456</latitude>
<longitude>-123.123456</longitude>
</coordinate>
<coordinate>
<latitude>12.123456</latitude>
<longitude>-123.123456</longitude>
</coordinate>
<coordinate>
<latitude>12.123456</latitude>
<longitude>-123.123456</longitude>
</coordinate>
<coordinate>
<latitude>12.123456</latitude>
<longitude>-123.123456</longitude>
</coordinate>
<coordinate>
<latitude>12.123456</latitude>
<longitude>-123.123456</longitude>
</coordinate>
</polygon>
<area_in_sqft>123456</area_in_sqft>
<area_in_miles>0.132456</area_in_miles>
<how_delineated>WHITEPAINT</how_delineated>
<excav_st_walk>Y</excav_st_walk>
<work_type>REPAIR AND REPLACE SOMETHING</work_type>
<boring>N</boring>
<explosives>N</explosives>
<vacuum>Y</vacuum>
<pavement_only>N</pavement_only>
<permit>123456789ABC</permit>
<work_order>AB123456</work_order>
<done_for>JOES RESTAURANT</done_for>
<project_id>12345</project_id>
<project_name>JOES PROJECT</project_name>
<name>ABC COMPANY</name>
<caller_type>CONT</caller_type>
<address1>123 MAIN ST</address1>
<city>SOMEWHERE</city>
<cstate>NY</cstate>
<zip>12345</zip>
<phone>1231231234</phone>
<caller>JIM SCHWILK</caller>
<caller_language>ENGLISH</caller_language>
<cell>1231231234</cell>
<sms_allowed>Y</sms_allowed>
<email>JIM@DOMAIN.COM</email>
<email_allowed>Y</email_allowed>
<contact>JAMES WINGATE</contact>
<contact_phone>1231231234</contact_phone>
<contact_cell>1231231234</contact_cell>
<contact_sms_allowed>Y</contact_sms_allowed>
<contact_email>JAMES@DOMAIN</contact_email>
<contact_email_allowed>Y</contact_email_allowed>
<location xml:space="preserve">DOG IN YARD</location>
<comments xml:space="preserve"></comments>
<hashtags xml:space="preserve"></hashtags>
<memberlist>
<member name="MBR001">MBR001 <member_contacts>
<mc_item>
<mc_type>EMER</mc_type>
<mc_contact>MBR001</mc_contact>
<mc_phone>1231231234</mc_phone>
<mc_email>MBR001@DOMAIN</mc_email>
</mc_item>
</member_contacts>
</member>
<member name="MBR020">MBR020 <member_contacts>
<mc_item>
<mc_type>EMER</mc_type>
<mc_contact>MBR020</mc_contact>
<mc_phone>1231231234</mc_phone>
<mc_email>MBR020@DOMAIN</mc_email>
</mc_item>
</member_contacts>
</member>
<member name="MBR039">MBR039 <member_contacts>
<mc_item>
<mc_type>EMER</mc_type>
<mc_contact>MBR039</mc_contact>
<mc_phone>1231231234</mc_phone>
<mc_email>MBR039@DOMAIN</mc_email>
</mc_item>
</member_contacts>
</member>
<member name="LONGMBR058">LONGMBR058 <member_contacts>
<mc_item>
<mc_type>EMER</mc_type>
<mc_contact>LONGMBR058</mc_contact>
<mc_phone>1231231234</mc_phone>
<mc_email>LONGMBR058@DOMAIN</mc_email>
</mc_item>
</member_contacts>
</member>
<member name="MBR153">MBR153 <member_contacts>
<mc_item>
<mc_type>EMER</mc_type>
<mc_contact>MBR153</mc_contact>
<mc_phone>1231231234</mc_phone>
<mc_email>MBR153@DOMAIN</mc_email>
</mc_item>
</member_contacts>
</member>
<member name="MBR172">MBR172 <member_contacts>
<mc_item>
<mc_type>EMER</mc_type>
<mc_contact>MBR172</mc_contact>
<mc_phone>1231231234</mc_phone>
<mc_email>MBR172@DOMAIN</mc_email>
</mc_item>
</member_contacts>
</member>
<member name="MBR191">MBR191 <member_contacts>
<mc_item>
<mc_type>EMER</mc_type>
<mc_contact>MBR191</mc_contact>
<mc_phone>1231231234</mc_phone>
<mc_email>MBR191@DOMAIN</mc_email>
</mc_item>
</member_contacts>
</member>
<member name="LONGMBR210">LONGMBR210 <member_contacts>
<mc_item>
<mc_type>EMER</mc_type>
<mc_contact>LONGMBR210</mc_contact>
<mc_phone>1231231234</mc_phone>
<mc_email>LONGMBR210@DOMAIN</mc_email>
</mc_item>
</member_contacts>
</member>
<member name="MBR324">MBR324 <member_contacts>
<mc_item>
<mc_type>EMER</mc_type>
<mc_contact>MBR324</mc_contact>
<mc_phone>1231231234</mc_phone>
<mc_email>MBR324@DOMAIN</mc_email>
</mc_item>
</member_contacts>
</member>
<member name="MBR343">MBR343 <member_contacts>
<mc_item>
<mc_type>EMER</mc_type>
<mc_contact>MBR343</mc_contact>
<mc_phone>1231231234</mc_phone>
<mc_email>MBR343@DOMAIN</mc_email>
</mc_item>
</member_contacts>
</member>
<member name="LONGMBR362">LONGMBR362 <member_contacts>
<mc_item>
<mc_type>EMER</mc_type>
<mc_contact>LONGMBR362</mc_contact>
<mc_phone>1231231234</mc_phone>
<mc_email>LONGMBR362@DOMAIN</mc_email>
</mc_item>
</member_contacts>
</member>
<member name="MBR077">MBR077 <member_contacts>
<mc_item>
<mc_type>EMER</mc_type>
<mc_contact>MBR077</mc_contact>
<mc_phone>1231231234</mc_phone>
<mc_email>MBR077@DOMAIN</mc_email>
</mc_item>
</member_contacts>
</member>
<member name="MBR096">MBR096 <member_contacts>
<mc_item>
<mc_type>EMER</mc_type>
<mc_contact>MBR096</mc_contact>
<mc_phone>1231231234</mc_phone>
<mc_email>MBR096@DOMAIN</mc_email>
</mc_item>
</member_contacts>
</member>
<member name="MBR115">MBR115 <member_contacts>
<mc_item>
<mc_type>EMER</mc_type>
<mc_contact>MBR115</mc_contact>
<mc_phone>1231231234</mc_phone>
<mc_email>MBR115@DOMAIN</mc_email>
</mc_item>
</member_contacts>
</member>
<member name="LONGMBR134">LONGMBR134 <member_contacts>
<mc_item>
<mc_type>EMER</mc_type>
<mc_contact>LONGMBR134</mc_contact>
<mc_phone>1231231234</mc_phone>
<mc_email>LONGMBR134@DOMAIN</mc_email>
</mc_item>
</member_contacts>
</member>
<member name="MBR229">MBR229 <member_contacts>
<mc_item>
<mc_type>EMER</mc_type>
<mc_contact>MBR229</mc_contact>
<mc_phone>1231231234</mc_phone>
<mc_email>MBR229@DOMAIN</mc_email>
</mc_item>
</member_contacts>
</member>
<member name="MBR248">MBR248 <member_contacts>
<mc_item>
<mc_type>EMER</mc_type>
<mc_contact>MBR248</mc_contact>
<mc_phone>1231231234</mc_phone>
<mc_email>MBR248@DOMAIN</mc_email>
</mc_item>
</member_contacts>
</member>
<member name="MBR267">MBR267 <member_contacts>
<mc_item>
<mc_type>EMER</mc_type>
<mc_contact>MBR267</mc_contact>
<mc_phone>1231231234</mc_phone>
<mc_email>MBR267@DOMAIN</mc_email>
</mc_item>
</member_contacts>
</member>
<member name="LONGMBR286">LONGMBR286 <member_contacts>
<mc_item>
<mc_type>EMER</mc_type>
<mc_contact>LONGMBR286</mc_contact>
<mc_phone>1231231234</mc_phone>
<mc_email>LONGMBR286@DOMAIN</mc_email>
</mc_item>
</member_contacts>
</member>
<member name="WBMWD">WBMWD <member_contacts>
<mc_item>
<mc_type>EMER</mc_type>
<mc_contact>WBMWD</mc_contact>
<mc_phone>1231231234</mc_phone>
<mc_email>WBMWD@DOMAIN</mc_email>
</mc_item>
</member_contacts>
</member>
</memberlist>
<map_url>https://somelink.doamin.com/linkinformationhereandthiscouldbealongstring</map_url>
<response_url>https://somelink.domain.com/eprlinkwithinformationthatislong</response_url>
</tickets>
</NewDataSet>
End of Day (EOD)
XML
<?xml version="1.0"?>
<NewDataSet>
<delivery>
<format_version>1.05.01.8</format_version>
<center>USASA</center>
<recipient>MBRCODE</recipient>
<transmission_type>SUM</transmission_type>
<transmitted>2022-08-02T16:03:08</transmitted>
</delivery>
<audit id="1">
<member>MBRCODE</member>
<seq_num>1</seq_num>
<ticket>A121231234</ticket>
<revision>01A</revision>
<delivered>2022-08-01T05:29:08</delivered>
<type>NRSP</type>
<category>LREQ</category>
<priority>RUSH</priority>
</audit>
<audit id="2">
<member>MBRCODE</member>
<seq_num>2</seq_num>
<ticket>A121231234</ticket>
<revision>01A</revision>
<delivered>2022-08-01T05:53:47</delivered>
<type>RNEW</type>
<category>LREQ</category>
<priority>NORM</priority>
</audit>
<audit id="3">
<member>MBRCODE</member>
<seq_num>3</seq_num>
<ticket>A121231234</ticket>
<revision>01A</revision>
<delivered>2022-08-01T05:55:06</delivered>
<type>RNEW</type>
<category>LREQ</category>
<priority>NORM</priority>
</audit>
<audit id="4">
<member>MBRCODE</member>
<seq_num>4</seq_num>
<ticket>A121231234</ticket>
<revision>01A</revision>
<delivered>2022-08-01T05:56:26</delivered>
<type>RNEW</type>
<category>LREQ</category>
<priority>NORM</priority>
</audit>
<audit id="5">
<member>MBRCODE</member>
<seq_num>5</seq_num>
<ticket>A121231234</ticket>
<revision>01A</revision>
<delivered>2022-08-01T06:05:33</delivered>
<type>NEW</type>
<category>LREQ</category>
<priority>SHRT</priority>
</audit>
<audit id="6">
<member>MBRCODE</member>
<seq_num>6</seq_num>
<ticket>A121231234</ticket>
<revision>01A</revision>
<delivered>2022-08-01T06:06:06</delivered>
<type>NEW</type>
<category>LREQ</category>
<priority>EMER</priority>
</audit>
<audit id="7">
<member>MBRCODE</member>
<seq_num>7</seq_num>
<ticket>A121231234</ticket>
<revision>01A</revision>
<delivered>2022-08-01T06:13:07</delivered>
<type>NEW</type>
<category>LREQ</category>
<priority>EMER</priority>
</audit>
<audit id="8">
<member>MBRCODE</member>
<seq_num>8</seq_num>
<ticket>A121231234</ticket>
<revision>01A</revision>
<delivered>2022-08-01T06:27:52</delivered>
<type>NEW</type>
<category>LREQ</category>
<priority>NORM</priority>
</audit>
<audit id="9">
<member>MBRCODE</member>
<seq_num>9</seq_num>
<ticket>A121231234</ticket>
<revision>01A</revision>
<delivered>2022-08-01T06:28:38</delivered>
<type>NRSP</type>
<category>LREQ</category>
<priority>RUSH</priority>
</audit>
<audit id="10">
<member>MBRCODE</member>
<seq_num>10</seq_num>
<ticket>A121231234</ticket>
<revision>01A</revision>
<delivered>2022-08-01T06:29:46</delivered>
<type>NRSP</type>
<category>LREQ</category>
<priority>RUSH</priority>
</audit>
<audit id="11">
<member>MBRCODE</member>
<seq_num>11</seq_num>
<ticket>A121231234</ticket>
<revision>01A</revision>
<delivered>2022-08-01T06:29:57</delivered>
<type>NRSP</type>
<category>LREQ</category>
<priority>RUSH</priority>
</audit>
<audit id="12">
<member>MBRCODE</member>
<seq_num>12</seq_num>
<ticket>A121231234</ticket>
<revision>01A</revision>
<delivered>2022-08-01T06:32:13</delivered>
<type>NEW</type>
<category>LREQ</category>
<priority>EMER</priority>
</audit>
<audit id="13">
<member>MBRCODE</member>
<seq_num>13</seq_num>
<ticket>A121231234</ticket>
<revision>01A</revision>
<delivered>2022-08-01T06:32:25</delivered>
<type>NEW</type>
<category>LREQ</category>
<priority>SHRT</priority>
</audit>
<audit id="14">
<member>MBRCODE</member>
<seq_num>14</seq_num>
<ticket>A121231234</ticket>
<revision>01A</revision>
<delivered>2022-08-01T06:34:07</delivered>
<type>NEW</type>
<category>LREQ</category>
<priority>EMER</priority>
</audit>
<audit id="15">
<member>MBRCODE</member>
<seq_num>15</seq_num>
<ticket>A121231234</ticket>
<revision>01A</revision>
<delivered>2022-08-01T06:35:38</delivered>
<type>RTRN</type>
<category>LREQ</category>
<priority>NORM</priority>
</audit>
<audit id="16">
<member>MBRCODE</member>
<seq_num>16</seq_num>
<ticket>A121231234</ticket>
<revision>01A</revision>
<delivered>2022-08-01T06:37:21</delivered>
<type>CNCL</type>
<category>LREQ</category>
<priority>RUSH</priority>
</audit>
<audit id="17">
<member>MBRCODE</member>
<seq_num>17</seq_num>
<ticket>A121231234</ticket>
<revision>01A</revision>
<delivered>2022-08-01T06:53:38</delivered>
<type>NEW</type>
<category>LREQ</category>
<priority>EMER</priority>
</audit>
<audit id="18">
<member>MBRCODE</member>
<seq_num>18</seq_num>
<ticket>A121231234</ticket>
<revision>01A</revision>
<delivered>2022-08-01T06:54:36</delivered>
<type>NEW</type>
<category>LREQ</category>
<priority>RUSH</priority>
</audit>
<audit id="19">
<member>MBRCODE</member>
<seq_num>19</seq_num>
<ticket>A121231234</ticket>
<revision>01A</revision>
<delivered>2022-08-01T06:55:43</delivered>
<type>CNCL</type>
<category>LREQ</category>
<priority>RUSH</priority>
</audit>
<audit id="20">
<member>MBRCODE</member>
<seq_num>20</seq_num>
<ticket>A121231234</ticket>
<revision>01A</revision>
<delivered>2022-08-01T07:00:41</delivered>
<type>DMGE</type>
<category>LREQ</category>
<priority>EMER</priority>
</audit>
<statistics>
<priority>
<norm>5</norm>
<shrt>2</shrt>
<rush>7</rush>
<emer>6</emer>
<dsgn>0</dsgn>
</priority>
<type>
<new>9</new>
<amnd>0</amnd>
<cncl>2</cncl>
<dmge>1</dmge>
<expd>0</expd>
<remk>0</remk>
<rnew>3</rnew>
<nrsp>4</nrsp>
<dsgn>0</dsgn>
<rtrn>1</rtrn>
<rsnd>0</rsnd>
</type>
<total_tranmissions>20</total_tranmissions>
</statistics>
</NewDataSet>
Download text files of XML tickets and EOD samples (Format 1 with EPR link) - CURRENT FORMAT