Skip to navigation

API version discovery and Webhook v2

An additive release for Risk Intelligence, Monitoring, Screening, Alerts, Cases and Transaction Monitoring.

Added

  • GET /api/v1/versions lists the contract versions the API supports, and GET /api/v1/versions/diff compares two of them.
  • Webhook endpoints can preview a version before moving to it.
  • Webhook v2: a timestamped signature in X-Myaza-Signature-V2, a stable event id for deduplication, and a replay window. See Verify signatures.

What you need to do

Nothing changes until you choose to upgrade. Existing organisations and webhook endpoints stay on the contract they were using.

  1. Exercise your requests in Sandbox, and confirm your code ignores fields it does not recognise.
  2. Send test deliveries to each webhook endpoint and verify the signature on the raw request bytes.
  3. Move endpoint versions first, then your organisation default, once Sandbox and Production clients are both ready.

No event names were added or removed.