TYPE | Fragment
|
Category | Objects |
Description
Object: HostingEvent
type
The type property has the following values
value |
description |
job |
This event was created from inside a job |
malware |
This event was created from a malware scan |
request |
This event was created in an api request( will not show up in callback ) |
action |
This event was created after an action was executed on by the hosting agent (on demand malware scan) deblacklisting ips etc |
cleanup |
This event was created after the renewal system decided the product should be cleaned up. In this case the hosting will be suspended | |
jobType
The jobType property has the following values
value |
description |
createHosting |
This job runs when a hosting is created |
cancelHosting |
This job runs when someone cancels the service on a hosting |
resumeHostingService |
This job runs when someone resumes the service on a hosting |
updateHostingPackage |
This job runs when someone changes the package for a hosting |
updateHostingEmail |
This job runs when someone changes the e-mail on a hosting |
updateHostingPassword |
This job runs when someone changes the password on a hosting |
updateHostingFTPPassword |
This job runs when someone changes the ftp password on a hosting |
deleteHosting |
This job runs when the hosting is deleted |
suspendHosting |
This job runs when the hosting is suspended |
unsuspendHosting |
This job runs when someone unsuspends the hosting |
suspendDomain |
This job runs when someone suspends the domain |
unsuspendDomain |
This job runs when someone unsuspends the domain |
syncHosting |
This job runs when we synchronise the hosting package stats data from the server. This should not show up in events |
updateHostingOptions |
This job runs when someone sets letsEncrypt to enabled or updates the malware scanner interval |
Properties
name |
type |
required |
default |
description |
id |
integer |
yes |
|
The hosting event id |
hostingIdentifier |
string |
no |
|
the hosting id for the callback option |
domainName |
string |
no |
|
the primary domain for the hosting product |
created |
integer |
yes |
|
Timestamp when this event was created |
delivered |
integer |
yes |
|
Timestamp when this event was delivered via a callback, if one was set. |
message |
string |
yes |
|
The message that describes the event |
type |
string |
yes |
|
The type of event |
jobId |
integer |
no |
|
the id of the job |
jobType |
string |
no |
|
the job type |
jobStatus |
string |
no |
|
the job status: done,failed,non_blocking_failure,ackedfailed |
responseId |
string |
no |
|
The response id this event is related to, set when this is a job/action that was initiated by an api request |
clientRequestId |
string |
no |
|
The client request id that originated this event |
context |
array |
yes |
|
Freeform context data of the event |
Sample JSON
{
"id": 103,
"created": 1648469037,
"message": "Job 389 completed with status done",
"type": "job",
"jobId": 389,
"jobType": "createHosting",
"jobStatus": "done",
"responseId": "1_04c0749a59af89211b3184940f817a495d50e082",
"hostingIdentifier": "1_1234123412341234123412341234123412342134",
"domainName": "test1234blorp.com",
"context": []
}