GET/webhook-endpoints

Lists the workspace's webhook endpoints, oldest first, disabled ones included.

https://api.postfa.st/Auth: pf-api-keyRate limit: 6,000 requests per day, 600 per hour

What is in the list

Disabled endpoints are listed too, so the array can be longer than the 5 active endpoints a workspace can have. There is no paging.

Check active, disabledReason, lastSuccessAt and lastFailureAt to see how an endpoint is doing.

Response

200 OK A bare array of the workspace's endpoints, oldest first. secret is never included.

idstring (UUID)required

The endpoint's id. Every other route takes it.

workspaceIdstring (UUID)required

The workspace the API key belongs to.

urlstringrequired

Where PostFast sends events, as stored: a query string is kept and a #fragment is dropped.

eventsstring[]required

The events this endpoint receives. Never empty.

post.publishedpost.failedaccount.connectedaccount.disconnected
descriptionstring | nulloptional

Your own label for the endpoint.

activebooleanrequired

Whether PostFast sends events to this endpoint.

disabledReasonstring | nulloptional

Why PostFast turned the endpoint off: GONE (the receiver answered 410) or FAILING (it kept failing, see /docs/webhooks#delivery). null while it is active, and when you turned it off yourself with active: false.

GONEFAILING
lastSuccessAtISO 8601 | nulloptional

When a delivery to this endpoint last succeeded.

lastFailureAtISO 8601 | nulloptional

When a delivery to this endpoint last failed.

createdAtISO 8601required

When the endpoint was created.

updatedAtISO 8601required

When the endpoint last changed.