Buttondown Documentation

Buttondown Documentation

© 2016–2025 Buttondown LLC.

TwitterGitHubLinkedInMastodonBlueskyFacebook

Introduction

Webhooks are used to notify external services of events that occur in the system. For example, when a newsletter is sent, a webhook can be used to notify an external service that the newsletter has been sent.

{
    "id": "13121cd6-0dfc-424c-bb12-988b0a32fcb3",
    "creation_date": "2020-09-29T00:00:00+00:00",
    "status": "enabled",
    "event_types": [
        "subscriber.created"
    ],
    "url": "https://example.com/webhook",
    "description": ""
}

Fields

id

Type
string
Description
A unique UUID associated with the object.

creation_date

Type
string
Description
The date and time at which the object was created.

status

Type
WebhookStatus
Description
Whether the webhook is enabled or not.

event_types

Type
array
Description
The types of event for which the webhook will be triggered.

url

Type
string
Description
The URL to which the webhook will send POST requests.

description

Type
string
Description
An optional description of the webhook, for reference.

© 2016–2025 Buttondown LLC.

TwitterGitHubLinkedInMastodonBlueskyFacebook