Webhooks walkthroughs

The Webhooks tool lets you create, update, and delete webhooks for your typeforms. Let's walk through a few common uses.

NOTE: These walkthroughs assume that you already have your Typeform access token and know how to pass it in the Authorization header of your request. If you need an access token or don't know how to pass it in the Authorization header, go to Get started first.

Let's say you want to create a new webhook for your typeform. You need two things to create a webhook: the form_id for the typeform and your webhook URL.

Send a PUT https://api.typeform.com/forms/{form_id}/webhooks/{tag} request with the webhook URL.

curl --request PUT \
  --url https://api.typeform.com/forms/{form_id}/webhooks/{tag} \
  --header 'Authorization: bearer {your_access_token}' \
  --header 'Content-Type: application/json' \
  -d '{"url":"https://{your_webhook_url}.com", "enabled":true}'

If you give the enabled element a value of true in your request, new data for your typeform will push to the webhook URL as soon as it is submitted.

You need to change your webhook URL — it happens! Here's how to do it:

Send a PUT https://api.typeform.com/forms/{form_id}/webhooks/{tag} request with the new webhook URL. Make sure to give the enabled element a value of true to start sending data to the new URL.

curl --request PUT \
  --url https://api.typeform.com/forms/{form_id}/webhooks/{tag} \
  --header 'Authorization: bearer {your_access_token}' \
  --header 'Content-Type: application/json' \
  -d '{"url":"https://{your_webhook_url}.com", "enabled":true}'

NOTE: You can also use the POST method to change a webhook URL.

When your typeform has run its course and you're not collecting any more submissions, you can delete the webhook. Just send a DELETE https://api.typeform.com/forms/{form_id}/webhooks/{tag} request for the webhook.

curl --request DELETE \
  --url https://api.typeform.com/forms/{form_id}/webhooks/{tag} \
  --header 'Authorization: bearer {your_access_token}'

And just like that, the webhook is deleted!

Great! If you need your access token, check out our Get started section. If you have your token, head to the Webhooks reference for endpoint information.

Looking for inspiration? Check out our Community projects page to see what other open-source developers have created with our APIs!