GET/webhook-endpoints/{id}

Fetches one webhook endpoint. Returns 404 once it has been deleted.

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

Path parameters

idstring (UUID)required

The endpoint's id, from POST /webhook-endpoints or GET /webhook-endpoints. A non-UUID returns 400.

Errors

StatusmessageWhen
404webhook.notFoundNo endpoint with this id in the workspace: it was deleted, it never existed, or it belongs to another workspace.

Response

200 OK The endpoint. 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.