webhook

Collection: webhooks

Webhooks allow you to configure Foxy to push data to an endpoint of your choosing. This is useful for providing notifications, syncing data, and more. Available webhook formats include: Foxy JSON webhook, Zapier, and Webflow.

Required Scopes

Full store_full_access
Read webhooks_read
Write webhooks_write
Resend webhooks_resend

Actions

GET View a webhook
PATCH Update a webhook (send only the properties you want to modify)
PUT Replace a webhook (send the entire representation)
DELETE Delete a webhook
HEAD Get just the header response
OPTIONS Get a response explaining which HTTP methods are supported

Properties (10)

name String · Required · max 255

The name of this webhook.

format String · Required

The type of this webhook.

jsonwebflowzapier
version Number

The version of this webhook. Should not be modified unless you have specific instructions from Foxy.

Default: 2

url String (nullable) · max 1000

The endpoint where webhook data will be sent.

query String (nullable) · max 1000

The webhook payload mirrors the API, and you can include more or less data according to your needs using zoom and other modifiers.

Something like zoom=items,items:options,customer.

encryption_key String (nullable) · Required · max 1000

The JSON webhooks are encrypted in certain situations. This key is also used to generate a signature to verify the integrity of the payload.

Required when format is json.

event_resource String

A webhook can be configured for different events, like when transactions are created or subscriptions are cancelled. Use subscription_event to receive a notification for each subscription lifecycle event logged (billing successes, billing failures, dunning, cancellations, etc.). Use subscription_mrr_snapshot to receive daily MRR snapshot data.

transactionsubscriptioncustomercarttransaction_logchangelogsubscription_eventsubscription_mrr_snapshot
is_active Boolean

If set to false, events will not be triggered for this webhook. This can also be set to false automatically if there are too many consecutive failed attempts to send a payload to this endpoint.

""1
date_created String (nullable) · Read-only

The date this resource was created.

date_modified String (nullable) · Read-only

The date this resource was last modified.

Link Relations (5)

self This Webhook
fx:store GET PATCH PUT DELETE This Store
fx:webhooks GET POST All webhooks
fx:statuses Statuses for this webhook
fx:logs Logs for this webhook
https://api.foxycart.com/webhooks/{id}

Example Representation

{
  "_links": {
    "curies": [
      {
        "name": "fx",
        "href": "https://api.foxycart.com/rels/{rel}",
        "templated": true
      }
    ],
    "self": {
      "href": "https://api.foxycart.com/webhooks/123",
      "title": "This Webhook"
    },
    "fx:store": {
      "href": "https://api.foxycart.com/stores/456",
      "title": "This Store"
    },
    "fx:webhooks": {
      "href": "https://api.foxycart.com/stores/456/webhooks",
      "title": "All webhooks"
    },
    "fx:statuses": {
      "href": "https://api.foxycart.com/webhooks/123/statuses",
      "title": "Statuses for this webhook"
    },
    "fx:logs": {
      "href": "https://api.foxycart.com/webhooks/123/logs",
      "title": "Logs for this webhook"
    }
  },
  "name": "My JSON endpoint",
  "format": "json",
  "version": 2,
  "url": "https://example.com",
  "query": "zoom=items",
  "encryption_key": "HNL978XVXXCM66DM5N2T78D5MT66BC6D",
  "event_resource": "transaction",
  "is_active": 1,
  "date_created": "2020-10-28T07:03:19-0700",
  "date_modified": "2020-10-28T08:45:46-0700"
}