Verify Push Webhooks

概要

Webhooks are a general pattern for how one system can be notified of events generated by another system in real-time. In the case of Verify Push, your app backend can be notified when a Factor has been verified or when a Challenge has been approved by the Verify Push service, so that it knows to advance the user to the next step in your flow. This is more real-time and efficient than constantly polling the Verify Push API for the status of a Factor or Challenge.

To configure webhooks, follow these steps:

1. Configure a webhook in your Verify Service via the Console UI
2. Receive, parse, and verify a webhook
3. Manage webhooks via Verify API (optional)

1. Configure a webhook in your Verify Service

前提条件

1. Create a Verify Service.
2. Create a REST API endpoint in your app backend that can receive HTTP POST requests.

Configure a webhook via Console UI

You can configure a webhook either via UI or API. We'll show the UI option first and then the API option later.

Go to Twilio Console > Verify > Service > Webhooks:

Click "Create Webhook Now" and complete the form:

• Enter a friendly name that will help you identify the webhook in the future.
• Select the events that you want to receive. See definitions in the Webhook Events table below.
• Enter the URL of your app backend's API endpoint.
• Click Create to finish creating your webhook.

Webhookイベント

2. Receive, parse, and verify a webhook

When Twilio makes an HTTP request to your app backend, it will include parameters related to the event that triggered it:

Verify the webhook's signature to confirm that it came from Twilio

• Each HTTP request is issued with the Content-Type header application/x-www-urlencoded and signed with an X-Twilio-Signature HTTP header.
• Twilio uses the parameters sent in the webhook and the exact URL your application supplied to Twilio to create this signature. The signature uses the HMAC-SHA1 hashing algorithm with your Twilio account's auth token as the secret key.
• Your application can verify that this signature is correct using the server side Twilio SDKs. You will need your account's auth token, the value of the X-Twilio-Signature HTTP header that Twilio passed to you, the URL that Twilio sent the webhook to, and all of the parameters sent by Twilio.
• For more information, check out our guide to Getting Started with Twilio Webhooks and Validating Requests are coming from Twilio. Find other webhook pages, such as a security guide and an FAQ in the Webhooks section of the docs.

3. Manage webhooks via Verify API (optional)

In addition to the Console UI, you can programmatically manage the Webhooks resource according to this API reference: