ITS Bulletins is a tool used to inform IT Services customers about incidents and changes in the services they use. Through ITS bulletins, customers are proactively informed about the recovery status of their service from the time an incident is reported to the time when an incident is resolved. In case of planned changes, customers are informed in advance about any outages or degradation of service quality during the change window.
Bulletin senders - As part of the Service Recovery Policy, Support Staff are required to issue bulletins in case of any emergency incidents to the service they support. It is important that all bulletin senders have been properly trained before using ITS Bulletins. To obtain more information on ITS Bulletins training, please contact GURU Team at guru@dhl.com.
Bulletin subscribers - IT Services customers have the ability to subscribe to receive bulletins about services they are interested in. ITS Bulletins are delivered to subscribers via email or SMS. Bulletin subscribers can manage and customize their individual subscriptions via the Subscription site.
ITS Bulletins tool offers 3 types of bulletins:
- Incident bulletin - used to inform customers about incidents and the status of recovery of affected service(s)
- Change bulletin - used to inform about planned changes to the service including outage or quality degradation information (not offered yet through API HUB)
- Information bulletin - any other information that needs to be delivered to customers
Scope
API enables sending important information through bulletins via enabled subscription to a selected Service.
Using the API
1. Request access to this API (ITS-API-HUB@dhl.com)
2. Create bulletin subscription - https://guru.dhl.com/bulletins/subscriptionSite/main.html
3. Send bulletin (use cases below)
Example Use Cases
Information bulletin
This example send information bulletin. Add "\n" for a new line in content field.
Curl Example: curl --location 'https://apihub-int.dhl.com/its/bulletin/information' \
--header 'dhl-api-key: <dhl-api-key-value>' \
--header 'Content-Type: application/json' \
--data '{
"services": "test4",
"countries": "CZ",
"state": "",
"regions": "GLOB",
"subject": "Test info bulletin",
"content": "\n \n Hi, \n \n this is our Monday information bulletin. \n Please, do not respond. \n \n Thank you.\n \n Your IT ...\n"
}'
Incident bulletin
This example send incident bulletin.
Curl Example: curl --location 'https://apihub-int.dhl.com/its/bulletin/incident' \
--header 'dhl-api-key: <dhl-api-key-value>' \
--header 'Content-Type: application/json' \
--data '{
"incidentNumber": "INC57356802",
"incidentType": "incident",
"state": "2",
"automatedAlerts": "1",
"description": "Important incident bulletin.",
"priority": "P2 - High",
"emergency": "1",
"service": "test4",
"impactedArea": "CZ",
"openedAt": "2023-12-14 15:00:52",
"resolvedAt": "2023-12-19 15:00:52",
"closureCode": "1547",
"solution": "done",
"site": "PRG",
"sector": "fee",
"customer": "ITS",
"businessUnit": "ITS"
}'
Get Access
Request access to this API (ITS-API-HUB@dhl.com).
Authentication
By requesting access you will get your private "dhl-api-key" which you add in message header.
Environments
Environment: https://apihub-int.dhl.com
Description: Production environment
Rate Limits
120pm
Additional Information
N/A
Release notes
N/A
N/A
More HTTP request example
- Please change message body properly.
The GURU API documentation is available on:
https://dpdhl.sharepoint.com/sites/GURU/tools/SitePages/GURU-ITS-Bulletins.aspx