Technical Contact

Colin Updated by Colin

The system-wide Technical Contact is meant to receive notifications for urgent error conditions that may require a technical expert to investigate and address.

These notifications currently include the following events, but others are likely to be added in the future:

  • Failing webhooks

Navigate to System > Configuration > General > General > Technical Contact to modify the configuration.

Merchant Scope Configuration

In some cases the context of the notification may be specific to a given Merchant, so you may wish to configure the notification to notify a technical contact designated by the Merchant by overriding the configuration at the merchant scope.

When the merchant scope differs from the global scope, the notification will be sent to both contacts unless the Notify Both setting is "No", in which case only the merchant-scope contact will be notified.

Slack-compatible Webhook URL

An HTTP POST request will be sent to the provided URL whenever there is an alert event. This payload is compatible with Slack's Incoming Webhooks so you may provide a Slack webhook or any other URL and the request body will be similar to the following example:

POST https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX
Content-type: application/json

{
	"text": "Webhook # 16 for ACME Inc to webhook.site is failing with error message: Response error code: \"28\". Error description: \"Operation timed out after 5001 milliseconds with 0 bytes received\"."
	"blocks": [
		{
			"type": "section",
			"text": {
				"type": "mrkdwn",
				"text": "_Action required:_ Webhooks failing for ACME Inc"
			}
		},
		{
			"type": "section",
			"text": {
				"type": "mrkdwn",
				"text": "*Warning!* Webhook subscriptions will be deactivated if failures persist for more than one week."
			}
		},
		{
			"type": "section",
			"text": {
				"type": "mrkdwn",
				"text": "Your <https://example.shipstream.app/admin/webhook/...|webhook #16> to webhook.site has had 5 errors since 2024-02-05 21:30:21. Please check that the endpoint URL is correct and healthy or deactivate the webhook to stop receiving these notifications if it should no longer be active."
			}
		},
		{
			"type": "section",
			"text": {
				"type": "mrkdwn",
				"text": "The most recent failure was:\n_Response error code: \"28\". Error description: \"Operation timed out after 5001 milliseconds with 0 bytes received\"._"
			}
		}
	]
}

How did we do?

Enumerations

Contact