Item notifications

Item Notifications let you keep external systems in sync with your Recurly catalog. Whenever you create, update, deactivate, or reactivate an item in your Recurly admin, a webhook is sent containing the item’s full metadata.

Prerequisites and limitations

Your site must have the Catalog feature enabled.
Notifications include the complete <item> payload—even for simple state changes.

New item notifications

New item

Sent when an item is created.

{
  "id": "ra8nn523yemt",
  "object_type": "item",
  "site_id": "qc326l1hl8k9",
  "event_type": "created",
  "event_time": "2022-07-26T22:46:31Z",
  "item_code": "f6e69ecf299"
}

<?xml version="1.0" encoding="UTF-8"?>
<new_item_notification>
  <item>
    <item_code>gray_socks</item_code>
    <name>Gray Socks</name>
    <description>Gray Socks</description>
    <external_sku>socks-12345</external_sku>
    <accounting_code>acc-12345</accounting_code>
    <revenue_schedule_type>evenly</revenue_schedule_type>
    <tax_exempt type="boolean">true</tax_exempt>
    <tax_code nil="nil"/>
    <pricing_type>fixed</pricing_type>
    <custom_fields type="array">
      <custom_field>
        <name>color</name>
        <value>gray</value>
      </custom_field>
    </custom_fields>
    <unit_amount_in_cents>
      <CAD type="integer">6000</CAD>
      <USD type="integer">1000</USD>
    </unit_amount_in_cents>
    <created_at type="datetime">2019-07-15T18:48:01Z</created_at>
    <updated_at type="datetime">2019-07-15T18:48:01Z</updated_at>
    <deleted_at nil="nil"/>
  </item>
</new_item_notification>

Updated Item

Sent when an item is updated.

{
  "id": "ra8nn523yemt",
  "object_type": "item",
  "site_id": "qc326l1hl8k9",
  "event_type": "updated",
  "event_time": "2022-07-26T22:46:32Z",
  "item_code": "f6e69ecf299"
}

<?xml version="1.0" encoding="UTF-8"?>
<updated_item_notification>
  <item>
    <item_code>gray_socks</item_code>
    <name>Gray Socks</name>
    <description>Gray Socks</description>
    <external_sku>socks-12345</external_sku>
    <accounting_code>acc-12345</accounting_code>
    <revenue_schedule_type>evenly</revenue_schedule_type>
    <tax_exempt type="boolean">true</tax_exempt>
    <tax_code nil="nil"/>
    <pricing_type>fixed</pricing_type>
    <custom_fields type="array">
      <custom_field>
        <name>color</name>
        <value>gray</value>
      </custom_field>
    </custom_fields>
    <unit_amount_in_cents>
      <CAD type="integer">6000</CAD>
      <USD type="integer">1000</USD>
    </unit_amount_in_cents>
    <created_at type="datetime">2019-07-15T18:48:01Z</created_at>
    <updated_at type="datetime">2019-07-15T18:48:01Z</updated_at>
    <deleted_at nil="nil"/>
  </item>
</updated_item_notification>

Deactivated item

Sent when an item is deactivated.

{
  "id": "ra8nn523yemt",
  "object_type": "item",
  "site_id": "qc326l1hl8k9",
  "event_type": "deactivated",
  "event_time": "2022-07-26T22:46:32Z",
  "item_code": "f6e69ecf299"
}

<?xml version="1.0" encoding="UTF-8"?>
<deactivated_item_notification>
  <item>
    <item_code>gray_socks</item_code>
    <name>Gray Socks</name>
    <description>Gray Socks</description>
    <external_sku>socks-12345</external_sku>
    <accounting_code>acc-12345</accounting_code>
    <revenue_schedule_type>evenly</revenue_schedule_type>
    <tax_exempt type="boolean">true</tax_exempt>
    <tax_code nil="nil"/>
    <pricing_type>fixed</pricing_type>
    <custom_fields type="array">
      <custom_field>
        <name>color</name>
        <value>gray</value>
      </custom_field>
    </custom_fields>
    <unit_amount_in_cents>
      <CAD type="integer">6000</CAD>
      <USD type="integer">1000</USD>
    </unit_amount_in_cents>
    <created_at type="datetime">2019-07-15T18:48:01Z</created_at>
    <updated_at type="datetime">2019-07-15T18:48:01Z</updated_at>
    <deleted_at nil="nil"/>
  </item>
</deactivated_item_notification>

Reactivated item

Sent when an item is reactivated.

{
  "id": "ra8nsl5lj561",
  "object_type": "item",
  "site_id": "qc326l1hl8k9",
  "event_type": "reactivated",
  "event_time": "2022-07-26T22:47:22Z",
  "item_code": "07aa63cc7c8"
}

<?xml version="1.0" encoding="UTF-8"?>
<reactivated_item_notification>
  <item>
    <item_code>gray_socks</item_code>
    <name>Gray Socks</name>
    <description>Gray Socks</description>
    <external_sku>socks-12345</external_sku>
    <accounting_code>acc-12345</accounting_code>
    <revenue_schedule_type>evenly</revenue_schedule_type>
    <tax_exempt type="boolean">true</tax_exempt>
    <tax_code nil="nil"/>
    <pricing_type>fixed</pricing_type>
    <custom_fields type="array">
      <custom_field>
        <name>color</name>
        <value>gray</value>
      </custom_field>
    </custom_fields>
    <unit_amount_in_cents>
      <CAD type="integer">6000</CAD>
      <USD type="integer">1000</USD>
    </unit_amount_in_cents>
    <created_at type="datetime">2019-07-15T18:48:01Z</created_at>
    <updated_at type="datetime">2019-07-15T18:48:01Z</updated_at>
    <deleted_at nil="nil"/>
  </item>
</reactivated_item_notification>

Updated 8 months ago