webhooks

Resource: webhook

This link relationship returns a collection of webhooks. You can paginate through this collection using the hypermedia links provided and the link relationships of first, prev, next, and last.

Required Scopes

Full store_full_access
Read webhooks_read
Write webhooks_write
Resend webhooks_resend

Collection Resource

webhook

Actions

GET View a list of webhooks
POST Create a new webhook
HEAD Get just the header response
OPTIONS Get a response explaining which HTTP methods are supported

Properties (5)

_embedded Object · Read-only

Contains fx:webhooks[] — array of webhook resources

total_items String · Read-only

Total number of resources in this collection.

returned_items Number · Read-only

Number of resources returned in this page.

limit Number · Read-only

Maximum number of resources per page.

offset Number · Read-only

Number of resources skipped.

Link Relations (5)

self This Collection
first First Page of this Collection
prev Previous Page of this Collection
next Next Page of this Collection
last Last Page of this Collection
https://api.foxycart.com/stores/{store_id}/webhooks
Available via fx:webhooks on store·fx:webhooks on webhook

Example Representation

{
  "_links": {
    "curies": [
      {
        "name": "fx",
        "href": "https://api.foxycart.com/rels/{rel}",
        "templated": true
      }
    ],
    "self": {
      "href": "https://api.foxycart.com/stores/123/webhooks",
      "title": "This Collection"
    },
    "first": {
      "href": "https://api.foxycart.com/stores/123/webhooks?offset=0",
      "title": "First Page of this Collection"
    },
    "prev": {
      "href": "https://api.foxycart.com/stores/123/webhooks?offset=0",
      "title": "Previous Page of this Collection"
    },
    "next": {
      "href": "https://api.foxycart.com/stores/123/webhooks?offset=20",
      "title": "Next Page of this Collection"
    },
    "last": {
      "href": "https://api.foxycart.com/stores/123/webhooks?offset=20",
      "title": "Last Page of this Collection"
    }
  },
  "_embedded": {
    "fx:webhooks": [
      {
        "_links": {
          "curies": [
            {
              "name": "fx",
              "href": "https://api.foxycart.com/rels/{rel}",
              "templated": true
            }
          ],
          "self": {
            "href": "https://api.foxycart.com/webhooks/456",
            "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"
      }
    ]
  },
  "total_items": 1,
  "returned_items": 1,
  "limit": 20,
  "offset": 0
}