Visibly Verification is an asynchronous process. While you can poll for updates, utilizing our webhook notifications via AWS SNS is highly recommended to ensure your system reacts immediately to status changes.
The createNotificationSubscription mutation allows you to subscribe an endpoint to receive real-time updates. You can choose between two notification protocols:
- HTTPS: Deliver JSON payloads directly to your server's webhook endpoint.
- EMAIL: Send status updates to a specified email address (ideal for initial testing).
Visibly requires a manual "Opt-In" for every new subscription.
- Trigger Mutation: Run the subscription mutation for your chosen endpoint.
- Receive Confirmation: A confirmation payload is sent to that endpoint immediately.
- Confirm Subscription: You must click the link provided in the confirmation payload to activate the flow.
Note: You will not receive verification updates until this step is completed.
- You can create an email subscription and confirm it via the link in your inbox.
- You can create an HTTPS subscription and successfully confirm it via your webhook endpoint.
Click here to see the createNotificationSubscription GraphQL reference