platform
numbers
number-registration
brands
brand-management

Receive Brand Auth 2FA Update

Any time a brand 2FA email changes state (sent, opened, confirmed, reissued, expired, undeliverable, hard bounced or an incorrect code was entered) or 2FA verification is completed, an event is sent. You need to subscribe to this event over 'REGISTRATION' channel, and specify the 'BRAND_AUTH_UPDATE' event.

postWebhookbrand-auth-2fa-update-notification

Payload

Example payload

{
  "results": [
    {
      "event": "BRAND_AUTH_UPDATE",
      "content": {
        "brandId": "0579c038-55f2-11ee-9458-325096b39f47",
        "brandAuthUpdate": "BRAND_EMAIL_2FA_SEND"
      },
      "platform": {
        "applicationId": "application-id",
        "entityId": "entity-id"
      }
    }
  ]
}

Response

Your server returns this code if it accepts the callback.

Changes

Webhooks have no change history: a webhook is keyed by its event name rather than a path and method, so no recorded change can name it.