send_webhooks

Send Webhooks allows you to send data for a specific transaction, customer, or subscription to the webhooks you specify.

To feed a webhook from the store resource, send a POST request to send_webhooks with the resource to feed and the webhook IDs to feed to:

[
    {
        "event": "refeed",
        "resource": "https://api.foxycart.com/transactions/transaction-id",
        "refeed_hooks": [webhook-id-1, webhook-id-2]
    }
]

You can bulk refeed by sending an array of objects.

To feed a webhook from the transactions, customers, or subscriptions resources, send a POST request to send_webhooks with the webhook IDs to feed to:

{
    "event": "refeed",
    "refeed_hooks": [webhook-id-1, webhook-id-2]
}

Required Scopes

Full store_full_access

Resend webhooks_resend

Actions

POST Send webhook data for a resource

OPTIONS Get a response explaining which HTTP methods are supported

Properties (3)

event String · Required

The event type. Use 'refeed' to resend webhook data.

resource String · Required

The full API URI of the resource to feed. Only needed when POSTing from the store-level send_webhooks endpoint.

Required when used from the store resource.

refeed_hooks Array · Required

An array of webhook IDs to send the data to.

https://api.foxycart.com/send_webhooks/{id}

Available via fx:send_webhooks on customer·fx:send_webhooks on store·fx:send_webhooks on subscription·fx:send_webhooks on transaction·fx:send_webhooks on transaction_log

Example Representation

No example representation available for this resource.