Skip to main content

PayComplete™™ Help Center

Alerting

Before setting up alerts in Connect, you must request Webhooks via your Sales representative. The Sales representative needs to contact Presales and ask them to submit a request to the development team.

The Webhook request must contain the following information:

  • Tenant ID

    Tenant identifier

    For example, tenant-abc123

  • Tenant name

    The official tenant name

    For example, Acme_Corporation.Ltd

  • Environment

    The Connect node where the Webhooks are needed.

    For example, https://connect.cloud.paycomplete.com

  • Message type - What type

    What type of message do you need Webhooks for?

    For example, 'transaction' or 'transaction-with-box-content'

  • Use case description

    A short explanation of what the queue will be used for

Webhooks are manually created by PayComplete™ based on the request you have submitted. The team creates SQS queues for message creation in AWS SNS SQS. Your SNS protocol can then process these messages.

Once you have Webhooks in place, you use the Alerts form in Connect to configure alerts for these messages:

  • Machine transactions

  • Machine contents (transaction + box contents)

  • Machine online status change

  • User balance change

Based on the message types, you can create alerts and define:

  • Sites

  • Machines

  • Machine UUID

  • The status that triggers the alert

  • The triggering event

    Some triggering events, such as High-frequency anomaly and Volume anomaly, have mandatory time filters

  • The recipients of the alerting emails.

You can configure alerts to be sent by email or SNS.

Warning

  • It's important to think through the alert cases before setting up alerts.

  • Be cautious when setting up alerts for errors. If not done correctly, you can receive an alert message every time the error message is sent. If the message is sent every second, you will get 3600 alerts per hour. Not just once per error.

See also

Articles