Go to App
API Reference

Attach to webhook(s)

What's a webhook

With webhooks you can have automated API calls sent from the Penbox app to your entry point when an event happens on a form.

Available events

'requests:created',
'requests:updated',
'requests:deleted',
'requests:archived',
'requests:unarchived',
'responses:created',
'responses:updated',
'responses:deleted',
'responses:completed'

How does it work in Penbox

You attach a webhook at the request creation level, it means you are in full control on which event you listen to & on which entry point you want to receive the update(s) for every single request you create.

Practical example / how you can easily test it

  1. Go to https://webhook.site

  2. Copy your unique URL & let the page opened

  3. Create a request via our CONNECT API

curl --request POST \
     --url https://connect.penbox.io/v1/requests \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "user": {
    "given_name": "John",
    "family_name": "Doe",
    "email": "[email protected]",
    "locale": "fr"
  },
  "flow": {
    "slug": "form-demo"
  },
  "draft": false,
  "webhooks": "{
    "https://webhook.site/c39542ef-dbaf-4cc9-919d-09d842c8372b": [
       "responses:completed"
    ]
  }
}
  1. Complete the request created and check the payload received on the page https://webhook.site you opened at step 1