Fields
None. Needs Webhook: Read, which a key of a Data Feed or an FFL Checkout store can hold.
A store has one webhook, whoever set it. managed_by says who: api for one set with PUT /webhook, plugin for the one the store's FFL Monkey Data Feed plugin set up when it connected. You can read the plugin's, but the API does not change, remove or test it. The secret is never shown here. How deliveries work is on Webhooks.
What it answers
| Field | Meaning |
|---|---|
| url | Where deliveries are sent, with a POST. |
| managed_by | api or plugin, as above. More values may be added. |
| event_patterns | The kinds of change sent, as patterns where * matches anything. For a webhook set with the API, your store's own families (see What is sent); the plugin's is *. |
| status | active; degraded while recent deliveries are failing and being retried; or paused, when nothing is sent. |
| paused_reason | Null unless status is paused. delivery_health after 50 failed deliveries in a row, which a PUT /webhook lifts once you have fixed the endpoint. Any other reason, such as billing, is not the API's to lift. More values may be added. |
| consecutive_failures | Failed deliveries since the last one that arrived. At 50 the webhook pauses. |
| last_success_at | When a delivery last arrived, or null. |
| last_failure_at | When a delivery last failed, or null. |
Returns
- 200The store's webhook, in
data. - 404webhook_not_set: the store has no webhook. Set one with PUT /webhook.
This endpoint can also answer 401 invalid_api_key, 403 license_not_active, 403 product_not_included, 403 insufficient_scope and 429 rate_limited.