Webhooks

Webhooks allow you to build or set up RIPE API integrated Apps which subscribe to certain events on RIPE. When one of those events is triggered, we'll send an HTTP POST payload to the webhook's configured URL. Webhooks can be used to update an external ERP, send emails, invalidate cache, etc. You're only limited by your imagination.

Events

NameDescription
order.pendingTriggered when any of the orders in the RIPE instance is marked as pending.
order.pending.<brand>Triggered when an order from the requested brand is marked as pending.
order.createdTriggered when any of the orders in the RIPE instance is set to created.
order.created.<brand>Triggered when an order from the requested brand is set to created.
order.productionTriggered when any of the orders in the RIPE instance is marked as in production.
order.production.<brand>Triggered when an order from the requested brand is marked as in production.
order.readyTriggered when any of the orders in the RIPE instance is marked as ready.
order.ready.<brand>Triggered when an order from the requested brand is marked as ready.
order.sentTriggered when any of the orders in the RIPE instance is marked as sent.
order.sent.<brand>Triggered when an order from the requested brand is marked as sent.
order.receivedTriggered when any of the orders in the RIPE instance is marked as received.
order.received.<brand>Triggered when an order from the requested brand is marked as received.
order.returnedTriggered when any of the orders in the RIPE instance is marked as returned.
order.returned.<brand>Triggered when an order from the requested brand is marked as returned.
order.canceledTriggered when any of the orders in the RIPE instance is marked as canceled.
order.canceled.<brand>Triggered when an order from the requested brand is marked as canceled.
availability_rule.createdTriggered when a new availability rule entry is created.
availability_rule.updatedTriggered when an availability rule entry is updated.
availability_rule.savedTriggered when an availability rule entry is saved (either created or updated).
availability_rule.deleteTriggered when an availability rule entry is deleted from the data source.
cites_rule.createdTriggered when a new cites rule entry is created.
cites_rule.updatedTriggered when a cites rule entry is updated.
cites_rule.savedTriggered when a cites rule entry is saved (either created or updated).
cites_rule.deleteTriggered when a cites rule entry is deleted from the data source.
code_rule.createdTriggered when a new code rule entry is created.
code_rule.updatedTriggered when a code rule entry is updated.
code_rule.savedTriggered when a code rule entry is saved (either created or updated).
code_rule.deleteTriggered when a code rule entry is deleted from the data source.
config_rule.createdTriggered when a new config rule entry is created.
config_rule.updatedTriggered when a config rule entry is updated.
config_rule.savedTriggered when a config rule entry is saved (either created or updated).
config_rule.deleteTriggered when a config rule entry is deleted from the data source.
ddp_rule.createdTriggered when a new ddp rule entry is created.
ddp_rule.updatedTriggered when a ddp rule entry is updated.
ddp_rule.savedTriggered when a ddp rule entry is saved (either created or updated).
ddp_rule.deleteTriggered when a ddp rule entry is deleted from the data source.
extra_duty_rule.createdTriggered when a new extra duty rule entry is created.
extra_duty_rule.updatedTriggered when an extra duty rule entry is updated.
extra_duty_rule.savedTriggered when an extra duty rule entry is saved (either created or updated).
extra_duty_rule.deleteTriggered when an extra duty rule entry is deleted from the data source.
factory_rule.createdTriggered when a new factory rule entry is created.
factory_rule.updatedTriggered when a factory rule entry is updated.
factory_rule.savedTriggered when a factory rule entry is saved (either created or updated).
factory_rule.deleteTriggered when a factory rule entry is deleted from the data source.
hs_code_map.createdTriggered when a new hs code map rule entry is created.
hs_code_map.updatedTriggered when a hs code map rule entry is updated.
hs_code_map.savedTriggered when a hs code map rule entry is saved (either created or updated).
hs_code_map.deleteTriggered when a hs code map rule entry is deleted from the data source.
hs_code_map.createdTriggered when a new hs code map entry is created.
hs_code_map.updatedTriggered when a hs code map entry is updated.
hs_code_map.savedTriggered when a hs code map entry is saved (either created or updated).
hs_code_map.deleteTriggered when a hs code map entry is deleted from the data source.
hs_code_rule.createdTriggered when a new hs code rule entry is created.
hs_code_rule.updatedTriggered when a hs code rule entry is updated.
hs_code_rule.savedTriggered when a hs code rule entry is saved (either created or updated).
hs_code_rule.deleteTriggered when a hs code rule entry is deleted from the data source.
inventory_rule.createdTriggered when a new inventory rule entry is created.
inventory_rule.updatedTriggered when an inventory rule entry is updated.
inventory_rule.savedTriggered when an inventory rule entry is saved (either created or updated).
inventory_rule.deleteTriggered when an inventory rule entry is deleted from the data source.
letter_rule.createdTriggered when a new letter rule entry is created.
letter_rule.updatedTriggered when a letter rule entry is updated.
letter_rule.savedTriggered when a letter rule entry is saved (either created or updated).
letter_rule.deleteTriggered when a letter rule entry is deleted from the data source.
note_rule.createdTriggered when a new note rule entry is created.
note_rule.updatedTriggered when a note rule entry is updated.
note_rule.savedTriggered when a note rule entry is saved (either created or updated).
note_rule.deleteTriggered when a note rule entry is deleted from the data source.
price_rule.createdTriggered when a new price rule entry is created.
price_rule.updatedTriggered when a price rule entry is updated.
price_rule.savedTriggered when a price rule entry is saved (either created or updated).
price_rule.deleteTriggered when a price rule entry is deleted from the data source.
shipping_rule.createdTriggered when a new shipping rule entry is created.
shipping_rule.updatedTriggered when a shipping rule entry is updated.
shipping_rule.savedTriggered when a shipping rule entry is saved (either created or updated).
shipping_rule.deleteTriggered when a shipping rule entry is deleted from the data source.

Payloads

Each event has its own payload, typically displaying the data being created/updated/deleted. One should expect the following payload structure:

{
  "url": "https://webhook.site/88998fc4-e09d-4519-9d39-7ecffbd916a1",
  "params": {
    "payload": {
      "_id": "5c800503a3a4ff004ef8f785",
      "id": 4993,
      "number": 4993,
      "enabled": true,
      "description": null,
      "created": 1551893763,
      "modified": 1551893763,
      "meta": {
        "timestamp": "2019-03-06T17:36:03.482Z"
      },
      "key": "95970f5244d37375be56aeadba27c992c00041a7",
      "status": "created",
      "production_status": "unset",
      "production": "produce",
      "gender": "male",
      "currency": "EUR",
      "country": "PT",
      "price": null,
      "prices": null,
      "brand": "dummy",
      "shoe": "dummy",
      "shoe_query": "model=dummy&brand=dummy&p=piping:leather_dmy:black&p=side:leather_dmy:black&p=top0_bottom:leather_dmy:black&p=shadow:default:default",
      "shoe_url": "/config/customization?model=dummy&brand=dummy&p=piping:leather_dmy:black&p=side:leather_dmy:black&p=top0_bottom:leather_dmy:black&p=shadow:default:default",
      "image_url": "/compose?model=dummy&brand=dummy&p=piping:leather_dmy:black&p=side:leather_dmy:black&p=top0_bottom:leather_dmy:black&p=shadow:default:default",
      "minify_hash": "NDIwNDI",
      "image_hash": "NDIwNDM",
      "image_o_hash": "NDIwNDQ",
      "top_hash": "NDIwNDU",
      "top_o_hash": "NDIwNDY",
      "bottom_hash": "NDIwNDc",
      "bottom_o_hash": "NDIwNDg",
      "back_hash": "NDIwNDk",
      "side_hash": "NDIwNTA",
      "structure": "{\"brand\": \"dummy\", \"model\": \"dummy\", \"variant\": \"\", \"parts\": [{\"color\": \"black\", \"material\": \"leather_dmy\", \"face\": \"side\", \"name\": \"piping\", \"hidden\": false, \"optional\": false}, {\"color\": \"black\", \"material\": \"leather_dmy\", \"face\": \"side\", \"name\": \"side\", \"hidden\": false, \"optional\": false}, {\"color\": \"black\", \"material\": \"leather_dmy\", \"face\": \"top\", \"name\": \"top0_bottom\", \"hidden\": false, \"optional\": false}, {\"color\": \"default\", \"hidden\": true, \"material\": \"default\", \"name\": \"shadow\", \"optional\": false}], \"parts_m\": {\"piping\": {\"color\": \"black\", \"material\": \"leather_dmy\", \"face\": \"side\"}, \"side\": {\"color\": \"black\", \"material\": \"leather_dmy\", \"face\": \"side\"}, \"top0_bottom\": {\"color\": \"black\", \"material\": \"leather_dmy\", \"face\": \"top\"}, \"shadow\": {\"color\": \"default\", \"hidden\": true, \"material\": \"default\"}}, \"gender\": \"male\", \"size\": 24, \"query\": \"model=dummy&brand=dummy&p=piping:leather_dmy:black&p=side:leather_dmy:black&p=top0_bottom:leather_dmy:black&p=shadow:default:default\", \"url\": \"/config/customization?model=dummy&brand=dummy&p=piping:leather_dmy:black&p=side:leather_dmy:black&p=top0_bottom:leather_dmy:black&p=shadow:default:default\", \"image\": \"/compose?model=dummy&brand=dummy&p=piping:leather_dmy:black&p=side:leather_dmy:black&p=top0_bottom:leather_dmy:black&p=shadow:default:default\", \"extras\": 0}",
      "ff_id": null,
      "ff_shoe_id": null,
      "ff_order_id": "00df7665-a218-4514-896e-1d6e5f192fd7",
      "delivery_time": null,
      "tracking_number": null,
      "tracking_url": null,
      "states": [],
      "attachments": [],
      "account": "root@root.com",
      "customer": "root@root.com",
      "ambassador": "root@root.com",
      "store": null,
      "number_s": "#004993",
      "delivery_d": 1554312963,
      "details": {
        "brand": "dummy",
        "model": "dummy",
        "variant": "",
        "parts": [
          {
            "color": "black",
            "material": "leather_dmy",
            "face": "side",
            "name": "piping",
            "hidden": false,
            "optional": false
          },
          {
            "color": "black",
            "material": "leather_dmy",
            "face": "side",
            "name": "side",
            "hidden": false,
            "optional": false
          },
          {
            "color": "black",
            "material": "leather_dmy",
            "face": "top",
            "name": "top0_bottom",
            "hidden": false,
            "optional": false
          },
          {
            "color": "default",
            "hidden": true,
            "material": "default",
            "name": "shadow",
            "optional": false
          }
        ],
        "parts_m": {
          "piping": {
            "color": "black",
            "material": "leather_dmy",
            "face": "side"
          },
          "side": {
            "color": "black",
            "material": "leather_dmy",
            "face": "side"
          },
          "top0_bottom": {
            "color": "black",
            "material": "leather_dmy",
            "face": "top"
          },
          "shadow": {
            "color": "default",
            "hidden": true,
            "material": "default"
          }
        },
        "gender": "male",
        "size": 24,
        "query": "model=dummy&brand=dummy&p=piping:leather_dmy:black&p=side:leather_dmy:black&p=top0_bottom:leather_dmy:black&p=shadow:default:default",
        "url": "/config/customization?model=dummy&brand=dummy&p=piping:leather_dmy:black&p=side:leather_dmy:black&p=top0_bottom:leather_dmy:black&p=shadow:default:default",
        "image": "/compose?model=dummy&brand=dummy&p=piping:leather_dmy:black&p=side:leather_dmy:black&p=top0_bottom:leather_dmy:black&p=shadow:default:default",
        "extras": 0
      }
    },
    (...)
  },
  "event": "order.created",
  "handler": "http"
}

{
  "url": "https://webhook.site/88998fc4-e09d-4519-9d39-7ecffbd916a1",
  "payload": {
    "enabled": true,
    "description": "",
    "created": 1551894521,
    "modified": 1551894521,
    "meta": {},
    "name": "",
    "priority": null,
    "brand": "swear",
    "shoe": "vyner",
    "variant": "",
    "part": "side",
    "material": "python",
    "color": "",
    "vat_included": false,
    "ddp_included": false,
    "fixed_price": false,
    "round_price": true,
    "pivot": "",
    "price_eur": 100,
    "price_usd": 110,
    "price_gbp": 90,
    "price_geo": {},
    "_id": "5c8007f9a3a4ff0052f8f766",
    "id": 21628
  },
  "event": "price_rule.created",
  "handler": "http"
}