How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Buttondown Webhooks API

The Webhooks API from Buttondown — 7 operation(s) covering webhook registration, delivery attempts, and test fires.

Buttondown Webhooks API is one of 31 APIs that Buttondown publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Webhook. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, and API documentation.

This API exposes 7 operations across 4 paths, and defines 11 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://api.buttondown.com/v1.

7 operations 4 paths 11 schemas 1 DELETE3 GET1 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.buttondown.com/v1
Authentication
API Key
License
Resource Areas
1

Authentication & Security 1

Buttondown Webhooks API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (ApiKeyAuth). By default, every request must be authenticated.

  • ApiKeyAuth — API key passed as 'Token ' in the Authorization header.

Paths & Operations 7

Across 4 paths, the API surfaces 7 operations — 1 DELETE, 3 GET, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Webhooks 7
POST
/webhooks
Create Webhook
create_webhook body → 201400403409422401429
GET
/webhooks
List Webhooks
list_webhooks 2 params → 200403409422401429
GET
/webhooks/{id}
Retrieve Webhook
retrieve_webhook 1 param → 200403404409401429
PATCH
/webhooks/{id}
Update Webhook
update_webhook 1 param body → 200400404409422401429
DELETE
/webhooks/{id}
Delete Webhook
delete_webhook 1 param → 204403404409401429
GET
/webhooks/{id}/attempts
Retrieve Webhook Attempts
retrieve_webhook_attempts 3 params → 200403404409422401429
POST
/webhooks/{id}/test
Test Webhook
test_webhook 2 params → 204400404409422401429

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are WebhookAttemptOutput (8 properties), Webhook (7 properties), WebhookInput (5 properties), WebhookPage (4 properties). Each schema is shown below with its type and property counts.

WebhookAttemptOutputPage
object
4 properties 2 required
WebhookPage
object
4 properties 2 required
ValidationErrorMessage
object
1 property 1 required
WebhookStatus
string
The status of a webhook.
ExternalEventType
string
Various types of events that are recorded by Buttondown, both in terms of exogenous systems like Stripe and Memberful, and endogenous ones like email opens and…
WebhookAttemptOutput
object
8 properties 3 required
WebhookInput
object
5 properties 2 required
Webhook
object
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 ex…
7 properties 5 required
ValidationErrorDetail
object
3 properties 3 required
WebhookAttemptStatus
string
An enumeration.
ErrorMessage
object
3 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

buttondown-webhooks-api-openapi.yml Raw ↑

Other APIs Buttondown publishes across the network.

Buttondown Accounts API
Buttondown Advertising Units API
Buttondown API Requests API
Buttondown Attachments API
Buttondown Automations API
Buttondown Books API
Buttondown Bulk Actions API
Buttondown Comments API
Buttondown Coupons API
Buttondown Emails API
Buttondown Events API
Buttondown Exports API
Where this information came from

This is an independent, third-party profile of Buttondown Webhooks API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.