Skip to content

What are webhooks and how to use them?

A

What are webhooks and how to use them?

Category: Integrations

Webhooks are automated messages sent from one app to another when something happens. They’re much like SMS notifications sent by your bank, e.g., when you receive payment. There is an action (payment) and a bank’s reaction (SMS). Webhooks work pretty much similarly.

This way, Konfeo can send a notification to your other app when someone registers for your free event or pays for a paid event (after the attendee’s status changes to accepted).

Notifications include: first and last name, email, event title, ticket/seat name, price and currency, info about additional attendees. The structure of webhooks is as follows:

{
    "type": "attendee_accepted",
    "attendee": {
        "id": 123,
        "name": "John",
        "surname": "Doe",
        "email": "john@doe.com"
    },
    "fee": {
        "price": 123.45,
        "currency": "USD"
    },
    "event": {
        "id": 234,
        "name": "Event name"
    },
    "group": {
        "id": 345,
        "name": "Group name"
    },
    "form_fields": [
        {
            "id": 45,
            "type": "text",
            "label": "Phone",
            "value": "123 456 789"
        },
        {
            "id": 46,
            "type": "text_area",
            "label": "Bio",
            "value": "Text"
        },
        {
            "id": 47,
            "type": "select",
            "label": "Food type",
            "value": "vegetarian"
        },
        {
            "id": 48,
            "type": "select",
            "label": "Weather",
            "value": null
        },
        {
            "id": 49,
            "type": "radio",
            "label": "T-shirt size",
            "value": "L"
        },
        {
            "id": 50,
            "type": "check_box",
            "label": "Newsletter",
            "value": true
        },
        {
            "id": 51,
            "type": "check_box",
            "label": "Marketing",
            "value": false
        }
    ],
    "additional_attendees": [
        {
            "id": 124,
            "name": "Jane",
            "surname": "Doe"
        }
    ]
}

Launching webhooks is very simple – go to the Event settings | Webhooks tab and enter the URL to which Konfeo should send them. That’s all.

Permalink