Docs
/
FFL Monkey

docs.fflmonkey.com/webhooks/test-webhook. For the whole Data Feed API as one document, use Print or save as PDF at the foot of the docs menu.

Docs / Webhooks

For Data Feed and FFL Checkout stores
Endpoint · Send a test event

POST/webhook/test

Send one signed test event to your webhook URL now, and see what your URL answered.

Needs Webhook: Read and writeBase URL https://backend.fflmonkey.com/api/v1Counts 1 toward 120 a minute

Fields

None. Needs Webhook: Read and write.

It sends one test event to your webhook URL now, signed and with the same headers as every delivery, so a receiver that accepts it accepts the real ones (see Check the signature). The event:

  • event_type is webhook.tested, and cursor is 0.
  • payload holds your license_id and the url it was sent to.
  • It is not one of your store's changes: it never appears in GET /changes, it is not retried, and a failed test does not count towards pausing the webhook. A test that arrives does not lift a pause either.

A paused webhook can be tested too, to check a fix before the PUT that resumes it. 5 tests a minute per store, whichever key sends them, on top of the key's own limit.

What it answers

Always 200 once something was tried: whether the test arrived is the answer.

FieldMeaning
deliveredtrue when your URL answered with any 2xx status.
statusThe HTTP status your URL answered with, or null when nothing answered.
duration_msHow long it took, in milliseconds.
errorWhat went wrong, in one sentence of ours, or null when it was delivered. What your server replied is never passed back.

Returns

  • 200The test was tried. data.delivered says whether it arrived.
  • 404webhook_not_set: the store has no webhook to test.
  • 409webhook_managed_by_plugin: the store's plugin manages its webhook.
  • 429rate_limited: more than 5 tests in a minute for this store. Wait for Retry-After seconds.

This endpoint can also answer 401 invalid_api_key, 403 license_not_active, 403 product_not_included, 403 insufficient_scope and 429 rate_limited.

Example

FFL Monkey API, version 1. Questions: Support in your FFL Monkey account, or [email protected].