Appendix B: Webhook notifications (Payment API)

Owned by Helen Griffith
Last updated: May 17, 2022

Webhooks enable external systems to be notified when a payment session status changes. Vonage Contact Center (VCC) can send HTTP POST requests to a webhook URL exposed by the agent’s external system. The webhook URL is associated with an account configuration and can be set during account setup.

The notification’s body is exactly the same as the payment session status response body.

During setup, Vonage can also configure authentication for webhooks. Authentication requires the authentication URI and credentials (OAuth client credentials flow is supported). Vonage can add more attributes if they are necessary.

VCC makes a call to the webhook URL when:

  • The payment is complete (a payment gateway used to authorize the card payment finishes processing the payment transaction, successfully or not)
  • The payment session ends without any payment gateway interaction

When VCC makes the call to the webhook URL, the agent’s system must respond with HTTP status code 200 (Success). In case of a delivery failure—for example, error status code, timeout, service unavailable—VCC retries the delivery every few minutes for 12 hours.