Catchpoint Events allows you to post events from your change management, DevOps tools, or any other event-driven service directly to Catchpoint. Catchpoint will automatically tag relevant performance data with the event, allowing you to correlate any changes or issues on your infrastructure with data captured in Catchpoint. Once we receive an event, it will show up in real-time in the portal.
Posting Events to Catchpoint
Enabling Events API
In order to post events to Catchpoint, the Events API must be enabled for your account. To enable the Events API, please contact your CSM or request access here
Logger URL
Events may be pushed from your service to the Catchpoint logger URL:
https://r.3gl.net/hawklogserver/f.p
Any information passed to the logger will be stored as an Event at the time we received the Event in the time zone of your account.
Events Posting Requirements
Catchpoint will only store events if the following criteria are met:
- The secret is included in the request header
Cp-Secret - The App ID is included in the payload
- The secret and App ID match
- There is an associated event type
Getting the secret and app ID
Note: this requires Manage API permissions
To view the app ID and secret, go Integrations > Event API.
The Logger URL, App ID, and Secret are displayed here. You can copy the secret by clicking the copy button next to that field.
Regenerating the secret
Note: this requires Manage API permissions
Clicking Regenerate creates a new secret. Any service using the previous secret will no longer work. The new secret is not applied until the API page is saved.
Event Payload
Events may be pushed in many content types, including:
- JSON
- XML
- CSV (comma-delimited)
- TSV (tab-delimited)
- Other Delimited
- Text w/Regular-Expressions
- MessagePack with payload handling either via JSON API or query string
The secret must be included with the header CP-Secret when pushing the events to Catchpoint. We will not store any data pushed to the logger that does not match the app ID displayed in the portal.
Our max permitted POST payload size is 64KB.
JSON API POST
The following information is required in the payload when posting Events to Catchpoint.
| Name | Description | Accepted Values |
| “s” | App ID | Integer |
| “e” | Event Type | ID from the following list
|
| “d” | Event Name | String, nested JSON dictionary, an array of JSON dictionaries |
| “t” | Custom event time | UTC Timestamp (If not set, Catchpoint uses the time that the event was posted to the webhook.) |
QueryString Parameters w/JSON POST
The query string will support the same parameters as in the JSON API, excluding the “d” data which would still need to be posted as either a JSON dictionary, a JSON array of dictionaries, or a simple string.
Optional Properties
*Note: Catchpoint currently supports these fields to store the event. The Limited Preview version of Events does not include support for these features on the Front End.
Advanced Properties
| Name | Use |
| "cte" | Content-Transfer Encoding override (of the 'Content-Transfer-Encoding' request header), used if the upload is encoded using hexadecimal (hex) or base64 (base64) encoding |
| "enc" | Text enclosure character override, used for parsing CSV (comma separated), TSV (tab-separated) or other delimited uploads, in case the delimited fields are enclosed with something besides the default enclosure (the double-quote character) |
| "fmt" | Upload format override (of the 'Content-Type' request header) |
| "sep" | Text separator override, used for parsing CSV, TSV or other delimited uploads. |
Event Response
Getting a response of ‘1’ means the post was successful. Getting a response of ‘2’ means the post was not formed correctly.