The Webhooks API provides a mechanism for subscribing to events that occur within the Firstup platform to receive http payloads when those events occur. Use webhook subscriptions to trigger actions on your own application.
Webhook events are sent by the Firstup platform as POST requests to your webhook url. Each event contains a payload specific to that event. More information about the webhooks system, including a list of events that can be subscribed to, is available on the Webhooks page.
## Fetch the program's configured webhook subscriptions - [GET /v2/webhooks/subscriptions](https://developers.firstup.io/doorman/openapi/webhooks/listwebhooksubscriptions.md): Fetchs multiple subscription records at a time, and can be paginated using cursor pagination. ## Create a new webhook subscription - [POST /v2/webhooks/subscriptions](https://developers.firstup.io/doorman/openapi/webhooks/createwebhooksubscription.md): Subscriptions are configurations that define what events you want to receive webhooks for. A url and at least one event are required for a subscription. If your server requires authorization, the authorization_header property allows you to specify what value to send in the "Authorization" http header of every delivery to your url. More information about creating webhook subscriptions is available on the Creating Webhook Subscriptions page, and the list of available events is available on the Event List page. The access token used when creating a subscription must have the webhooks.write auth scope. ## Update an existing webhook subscription - [PUT /v2/webhooks/subscriptions/{subscription_id}](https://developers.firstup.io/doorman/openapi/webhooks/updatewebhooksubscription.md): After creation, subscriptions can be updated to change what events are subscribed to, what url to send the payloads to, and other settings such as whether the subscription is active. Any values that can be set on the subscription when creating it can be updated. The update method is a patch operation, so only properties you send in the request will be updated on the record. The events property, however, does not support partial updates as an array. The access token used when updating a subscription must have the webhooks.write auth scope. ## Delete a webhook subscription permanently - [DELETE /v2/webhooks/subscriptions/{subscription_id}](https://developers.firstup.io/doorman/openapi/webhooks/deletewebhooksubscription.md): Deactivate a webhook subscription and remove the record permanently. Warning: you cannot undo this action. ## Fetch a single webhook subscription record - [GET /v2/webhooks/subscriptions/{subscription_id}](https://developers.firstup.io/doorman/openapi/webhooks/detailwebhooksubscription.md) ## Test a webhook subscription by pinging it with a sample payload - [POST /v2/webhooks/subscriptions/{subscription_id}/ping](https://developers.firstup.io/doorman/openapi/webhooks/pingwebhooksubscription.md): More information about testing webhook subscriptions is available on the Testing Webhook Subscriptions page.