Do you want to search in all categories or in this category ?
Home
All Categories
Subshero
Dev Docs
Webhook Documentation

Webhook Documentation

Written by Yaroslav M
Last update: Friday, Dec 09, 2022

Subhero Webhook

A webhook in web development is a method of augmenting or altering the behavior of a web page or web application with custom callbacks.

Incoming Webhook

Event: Subscription Create

URL : "https://api.subshero.com/webhook/user/data/AxlcmXOxrqEhjjwKSuiRA0tTVnluwXV3"

  • The subscription or Lifetime is created based on " brand_id"

Raw Data :

{ "brand_id":"11", "type":"1", "price":"99", "price_type":"USD", "billing_type":"2", "billing_frequency":"1", "billing_cycle":"1", "payment_date":"2022-01-09", "status":"1", "recurring":"1" }

Example Request :

curl --location -g --request POST "https://api.subshero.com/webhook/user/data/AxlcmXOxrqEhjjwKSuiRA0tTVnluwXV3" \
--header "x-subshero-webhook-event: created" \
--header "x-subshero-webhook-resource: subscription" \
--header "x-subshero-webhook-topic: subscription.created" \
--data-raw '{
    "brand_id": "11",
    "type": "1",
    "price": "99",
    "price_type": "USD",
    "billing_type": "2",
    "billing_frequency": "1",
    "billing_cycle": "1",
    "payment_date": "2022-01-09",
    "status": "1",
    "recurring": "1"
}'

Event: Subscription Update

URL : "https://api.subshero.com/webhook/user/data/yqy7JEIExtQu3OGUQbRe3UFJ4GENjk5f"

  • To Update the subscription/ lifetime you would need the "subscription_id" of the product.

Raw Data :

{"id":"2596", "brand_id":"11", "type":"1", "price":"101.99", "price_type":"USD", "billing_type":"2", "billing_frequency":"1", "billing_cycle":"1", "payment_date":"2022-01-09", "status":"1", "recurring":"1" }

Example Request :

curl --location -g --request POST " https://api.subshero.com/webhook/user/data/yqy7JEIExtQu3OGUQbRe3UFJ4GENjk5f" \
--header "x-subshero-webhook-event: updated" \
--header "x-subshero-webhook-resource: subscription"\
--header "x-subshero-webhook-topic: subscription.updated" \
--data-raw '{
    "id": "2596",
    "brand_id": "11",
    "type": "1",
    "price": "888.99",
    "price_type": "USD",
    "billing_type": "2",
    "billing_frequency": "1",
    "billing_cycle": "1",
    "payment_date": "2022-01-09",
    "status": "1",
    "recurring": "1"
}'

Event: Subscription Delete

URL : "https://api.subshero.com/webhook/user/data/yqy7JEIExtQu3OGUQbRe3UFJ4GENjk5f"

Raw data :

{"id":"2597" }

Example Request :

curl --location -g --request POST "https://api.subshero.com/webhook/user/data/yqy7JEIExtQu3OGUQbRe3UFJ4GENjk5f" \
--header "x-subshero-webhook-event: deleted" \
--header "x-subshero-webhook-resource: subscription" \
--header "x-subshero-webhook-topic: subscription.deleted" \
--data-raw '{"id":"2597" }'

Event: Subscription Refund

URL : "https://api.subshero.com/webhook/user/data/yqy7JEIExtQu3OGUQbRe3UFJ4GENjk5f"

  • Refunding any Subcription/ Lifeitme would be using "subcription_id" .

Raw Data :

{"id":"2593" }

Example Request :

curl --location -g --request POST "https://api.subshero.com/webhook/user/data/yqy7JEIExtQu3OGUQbRe3UFJ4GENjk5f" \
--header "x-subshero-webhook-event: refunded" \
--header "x-subshero-webhook-resource: subscription" \
--header "x-subshero-webhook-topic: subscription.refunded" \
--data-raw '{"id":"2593" }'

Event: Subscription Cancel

URL : "https://api.subshero.com/webhook/user/data/yqy7JEIExtQu3OGUQbRe3UFJ4GENjk5f"

  • Cancelling any Subscription/ Lifetime would be using "subscription_id" .

Raw Data :

{"id":"2596" }

Example Request:

curl --location -g --request POST "https://api.subshero.com/webhook/user/data/yqy7JEIExtQu3OGUQbRe3UFJ4GENjk5f" \
--header "x-subshero-webhook-event: canceled" \
--header "x-subshero-webhook-resource: subscription" \
--header "x-subshero-webhook-topic: subscription.canceled" \
--data-raw '{
    "id": "2596"
}'

Outgoing Webhook :

Event : Subscription Create

Endpoint URL :

URL : "https://webhook.site/99eb13d6-e26a-46d8-b178-f14eecaed155/"

Request Headers :

x-subshero-webhook-id : 33
x-subshero-webhook-event: subscription.created
x-subshero-webhook-source: https://api.subshero.com
content-type: application/json

Example Response

{
  "id": 5350,
  "user_id": 85,
  "folder_id": 207,
  "brand_id": 13,
  "category_id": 17,
  "alert_id": 1,
  "platform_id": null,
  "type": 1,
  "image": "https://api.subshero.com/storage/Y2xpZW50LzEvcHJvZHVjdC9sb2dvcy90cmVsbG8ucG5n?v=1.79",
  "favicon": "https://api.subshero.com/storage/Y2xpZW50LzEvcHJvZHVjdC9mYXZpY29ucy90cmVsbG8ucG5n?v=1.79",
  "product_name": "Trello",
  "brandname": "Atlassian",
  "product_type": {
    "id": 1,
    "name": "Saas"
  },
  "description": "It is an application that was started by Fog creek software to help them manage their own projects.",
  "price": 10,
  "price_type": "USD",
  "recurring": 1,
  "payment_date": "2021-08-09",
  "next_payment_date": null,
  "payment_date_upd": "2021-08-09",
  "expiry_date": "2024-03-09",
  "contract_expiry": null,
  "homepage": null,
  "pay_gateway_id": 0,
  "note": null,
  "company_name": null,
  "discount_voucher": null,
  "payment_mode": null,
  "payment_mode_id": 699,
  "include_notes": null,
  "alert_type": 1,
  "url": "https://trello.com",
  "support_details": null,
  "tags": [
    {
      "id": 320,
      "name": "Marketing"
    },
    {
      "id": 321,
      "name": "Design"
    }
  ],
  "billing_frequency": 2,
  "billing_cycle": 3,
  "billing_type": 2,
  "ltdval_price": "0.00",
  "ltdval_frequency": 1,
  "ltdval_cycle": 4,
  "status": 1,
  "pricing_type": 1,
  "timezone": "America/New_York",
  "currency_code": "USD",
  "refund_days": 123,
  "refund_date": "2021-12-10",
  "base_value": "10.00",
  "base_currency": "USD",
  "rating": 10,
  "sub_addon": 0,
  "sub_id": null,
  "created_at": "2022-12-08 00:56:10",
  "created_by": 85,
  "type_value": "Subscription",
  "recurring_value": "Recurring",
  "billing_cycle_value": "Monthly",
  "billing_type_value": "Date",
  "ltdval_cycle_value": "Yearly",
  "status_value": "Active",
  "pricing_type_value": "Subscription",
  "sub_addon_value": "Subscription",
  "folder": {
    "id": 207,
    "name": "Sub",
    "color": null,
    "is_default": 0
  },
  "product": {
    "id": 13,
    "product_name": "Trello",
    "brandname": "Atlassian",
    "category_id": 17,
    "product_type": 1,
    "description": "It is an application that was started by Fog creek software to help them manage their own projects."
  },
  "product_category": {
    "id": 17,
    "name": "Project Management"
  }
}

Event : Subscription Update

Endpoint URL :

"https://webhook.site/99eb13d6-e26a-46d8-b178-f14eecaed155/"

Request Headers :

x-subshero-webhook-id : 33
x-subshero-webhook-event: subscription.updated
x-subshero-webhook-source: https://api.subshero.com
content-type: application/json

Example Response :

{
  "id": 5350,
  "user_id": 85,
  "folder_id": 207,
  "brand_id": 13,
  "category_id": 17,
  "alert_id": 1,
  "platform_id": null,
  "type": 1,
  "image": "https://devcdn.subshero.com/storage/Y2xpZW50LzEvcHJvZHVjdC9sb2dvcy90cmVsbG8ucG5n?v=1.79",
  "favicon": "https://devcdn.subshero.com/storage/Y2xpZW50LzEvcHJvZHVjdC9mYXZpY29ucy90cmVsbG8ucG5n?v=1.79",
  "product_name": "Trello",
  "brandname": "Atlassian",
  "product_type": {
    "id": 1,
    "name": "Saas"
  },
  "description": "It is an application that was started by Fog creek software to help them manage their own projects.",
  "price": 190,
  "price_type": "USD",
  "recurring": 1,
  "payment_date": "2021-08-09",
  "next_payment_date": null,
  "payment_date_upd": "2022-12-09",
  "expiry_date": "2024-03-09",
  "contract_expiry": null,
  "homepage": null,
  "pay_gateway_id": 0,
  "note": null,
  "company_name": null,
  "discount_voucher": null,
  "payment_mode": null,
  "payment_mode_id": 699,
  "include_notes": null,
  "alert_type": 1,
  "url": "https://trello.com",
  "support_details": null,
  "tags": [
    {
      "id": 320,
      "name": "Marketing"
    },
    {
      "id": 321,
      "name": "Design"
    },
  ],
  "billing_frequency": 1,
  "billing_cycle": 3,
  "billing_type": 2,
  "ltdval_price": "1099.00",
  "ltdval_frequency": 1,
  "ltdval_cycle": 4,
  "status": 1,
  "pricing_type": 1,
  "timezone": "America/New_York",
  "currency_code": "USD",
  "refund_days": 123,
  "refund_date": "2021-12-10",
  "base_value": "190.00",
  "base_currency": "USD",
  "rating": 10,
  "sub_addon": 0,
  "sub_id": null,
  "created_at": "2022-12-08 00:56:10",
  "created_by": 85,
  "type_value": "Subscription",
  "recurring_value": "Recurring",
  "billing_cycle_value": "Monthly",
  "billing_type_value": "Date",
  "ltdval_cycle_value": "Yearly",
  "status_value": "Active",
  "pricing_type_value": "Subscription",
  "sub_addon_value": "Subscription",
  "folder": {
    "id": 207,
    "name": "Sub",
    "color": null,
    "is_default": 0
  },
  "product": {
    "id": 13,
    "product_name": "Trello",
    "brandname": "Atlassian",
    "category_id": 17,
    "product_type": 1,
    "description": "It is an application that was started by Fog creek software to help them manage their own projects."
  },
  "product_category": {
    "id": 17,
    "name": "Project Management"
  }
}

Event: Subscription Delete

Endpoint URL :

"https://webhook.site/99eb13d6-e26a-46d8-b178-f14eecaed155/"

Request Headers :

x-subshero-webhook-id : 33
x-subshero-webhook-event: subscription.deleted
x-subshero-webhook-source: https://api.subshero.com
content-type: application/json

Example Response :

{
  "id": 5314,
  "user_id": 85,
  "folder_id": 207,
  "brand_id": 13,
  "category_id": 17,
  "alert_id": 1,
  "platform_id": null,
  "type": 1,
  "image": "https://devcdn.subshero.com/storage/Y2xpZW50LzEvcHJvZHVjdC9sb2dvcy90cmVsbG8ucG5n?v=1.79",
  "favicon": "https://devcdn.subshero.com/storage/Y2xpZW50LzEvcHJvZHVjdC9mYXZpY29ucy90cmVsbG8ucG5n?v=1.79",
  "product_name": "Trello",
  "brandname": "Atlassian",
  "product_type": {
    "id": 1,
    "name": "Saas"
  },
  "description": "It is an application that was started by Fog creek software to help them manage their own projects.",
  "price": 190,
  "price_type": "USD",
  "recurring": 1,
  "payment_date": "2022-03-09",
  "next_payment_date": "2022-12-14",
  "payment_date_upd": "2022-12-14",
  "expiry_date": null,
  "contract_expiry": null,
  "homepage": null,
  "pay_gateway_id": 0,
  "note": null,
  "company_name": null,
  "discount_voucher": null,
  "payment_mode": null,
  "payment_mode_id": 699,
  "include_notes": null,
  "alert_type": 1,
  "url": "https://trello.com",
  "support_details": null,
  "tags": [
    {
      "id": 320,
      "name": "Marketing"
    }
  ],
  "billing_frequency": 2,
  "billing_cycle": 2,
  "billing_type": 2,
  "ltdval_price": "1212.00",
  "ltdval_frequency": 1,
  "ltdval_cycle": 4,
  "status": 1,
  "pricing_type": 1,
  "timezone": "America/New_York",
  "currency_code": "USD",
  "refund_days": 121,
  "refund_date": "2022-07-08",
  "base_value": "190.00",
  "base_currency": "USD",
  "rating": 10,
  "sub_addon": 0,
  "sub_id": null,
  "created_at": "2022-11-30 08:58:52",
  "created_by": 85,
  "type_value": "Subscription",
  "recurring_value": "Recurring",
  "billing_cycle_value": "Weekly",
  "billing_type_value": "Date",
  "ltdval_cycle_value": "Yearly",
  "status_value": "Active",
  "pricing_type_value": "Subscription",
  "sub_addon_value": "Subscription",
  "folder": {
    "id": 207,
    "name": "Sub",
    "color": null,
    "is_default": 0
  },
  "product": {
    "id": 13,
    "product_name": "Trello",
    "brandname": "Atlassian",
    "category_id": 17,
    "product_type": 1,
    "description": "It is an application that was started by Fog creek software to help them manage their own projects."
  },
  "product_category": {
    "id": 17,
    "name": "Project Management"
  }
}

Event: Subscription Cancel

Endpoint URL :

"https://webhook.site/99eb13d6-e26a-46d8-b178-f14eecaed155/"

Request Headers :

x-subshero-webhook-id : 33
x-subshero-webhook-event: subscription.canceled
x-subshero-webhook-source: https://api.subshero.com
content-type: application/json

Example Response

{
  "id": 5353,
  "user_id": 85,
  "folder_id": 207,
  "brand_id": 20,
  "category_id": 28,
  "alert_id": 1,
  "platform_id": null,
  "type": 1,
  "image": "https://devcdn.subshero.com/storage/Y2xpZW50LzEvcHJvZHVjdC9sb2dvcy9jb252ZXJ0a2l0LnBuZw==?v=1.79",
  "favicon": "https://devcdn.subshero.com/storage/Y2xpZW50LzEvcHJvZHVjdC9mYXZpY29ucy9jb252ZXJ0a2l0LnBuZw==?v=1.79",
  "product_name": "ConvertKit",
  "brandname": "ConvertKit",
  "product_type": {
    "id": 1,
    "name": "Saas"
  },
  "description": "By sharing your passions and expressing yourself openly with the world, you can start a movement and promote your ideas.",
  "price": 9,
  "price_type": "USD",
  "recurring": 1,
  "payment_date": "2020-03-02",
  "next_payment_date": "2023-03-02",
  "payment_date_upd": "2023-03-02",
  "expiry_date": "2026-07-11",
  "contract_expiry": null,
  "homepage": null,
  "pay_gateway_id": 0,
  "note": null,
  "company_name": null,
  "discount_voucher": null,
  "payment_mode": null,
  "payment_mode_id": 699,
  "include_notes": null,
  "alert_type": 1,
  "url": "https://convertkit.com/",
  "support_details": null,
  "tags": [
    {
      "id": 320,
      "name": "Marketing"
    }
  ],
  "billing_frequency": 1,
  "billing_cycle": 4,
  "billing_type": 2,
  "ltdval_price": "0.00",
  "ltdval_frequency": 1,
  "ltdval_cycle": 3,
  "status": 1,
  "pricing_type": 1,
  "timezone": "America/New_York",
  "currency_code": "USD",
  "refund_days": 132,
  "refund_date": "2020-07-12",
  "base_value": "9.00",
  "base_currency": "USD",
  "rating": 10,
  "sub_addon": 0,
  "sub_id": null,
  "created_at": "2022-12-08 01:10:56",
  "created_by": 85,
  "type_value": "Subscription",
  "recurring_value": "Recurring",
  "billing_cycle_value": "Yearly",
  "billing_type_value": "Date",
  "ltdval_cycle_value": "Monthly",
  "status_value": "Active",
  "pricing_type_value": "Subscription",
  "sub_addon_value": "Subscription",
  "folder": {
    "id": 207,
    "name": "Sub",
    "color": null,
    "is_default": 0
  },
  "product": {
    "id": 20,
    "product_name": "ConvertKit",
    "brandname": "ConvertKit",
    "category_id": 28,
    "product_type": 1,
    "description": "By sharing your passions and expressing yourself openly with the world, you can start a movement and promote your ideas."
  },
  "product_category": {
    "id": 28,
    "name": "Marketing"
  }
}

Event: Subscription Refund

Endpoint URL :

"https://webhook.site/99eb13d6-e26a-46d8-b178-f14eecaed155/"

Request Headers :

x-subshero-webhook-id : 33
x-subshero-webhook-event: subscription.refunded
x-subshero-webhook-source: https://api.subshero.com
content-type: application/json

Example Response :

{
  "id": 5352,
  "user_id": 85,
  "folder_id": 207,
  "brand_id": 19,
  "category_id": 30,
  "alert_id": 1,
  "platform_id": null,
  "type": 1,
  "image": "https://devcdn.subshero.com/storage/Y2xpZW50LzEvcHJvZHVjdC9sb2dvcy92b25hZ2UucG5n?v=1.79",
  "favicon": "https://devcdn.subshero.com/storage/Y2xpZW50LzEvcHJvZHVjdC9mYXZpY29ucy92b25hZ2UucG5n?v=1.79",
  "product_name": "Vonage",
  "brandname": "Vonage",
  "product_type": {
    "id": 1,
    "name": "Saas"
  },
  "description": "vonage delivers the most innovative and complete cloud communications platform for enterprises and small businesses.",
  "price": 30,
  "price_type": "USD",
  "recurring": 1,
  "payment_date": "2022-12-08",
  "next_payment_date": "2023-02-08",
  "payment_date_upd": "2023-02-08",
  "expiry_date": "2024-11-09",
  "contract_expiry": null,
  "homepage": null,
  "pay_gateway_id": 0,
  "note": null,
  "company_name": null,
  "discount_voucher": null,
  "payment_mode": null,
  "payment_mode_id": 699,
  "include_notes": null,
  "alert_type": 1,
  "url": "https://www.vonage.com/",
  "support_details": null,
  "tags": [
    {
      "id": 320,
      "name": "Marketing"
    },
    {
      "id": 322,
      "name": "Community"
    }
  ],
  "billing_frequency": 2,
  "billing_cycle": 3,
  "billing_type": 2,
  "ltdval_price": "0.00",
  "ltdval_frequency": null,
  "ltdval_cycle": null,
  "status": 1,
  "pricing_type": 1,
  "timezone": "America/New_York",
  "currency_code": "USD",
  "refund_days": 124,
  "refund_date": "2023-04-11",
  "base_value": "30.00",
  "base_currency": "USD",
  "rating": 10,
  "sub_addon": 0,
  "sub_id": null,
  "created_at": "2022-12-08 01:09:54",
  "created_by": 85,
  "type_value": "Subscription",
  "recurring_value": "Recurring",
  "billing_cycle_value": "Monthly",
  "billing_type_value": "Date",
  "ltdval_cycle_value": null,
  "status_value": "Active",
  "pricing_type_value": "Subscription",
  "sub_addon_value": "Subscription",
  "folder": {
    "id": 207,
    "name": "Sub",
    "color": null,
    "is_default": 0
  },
  "product": {
    "id": 19,
    "product_name": "Vonage",
    "brandname": "Vonage",
    "category_id": 30,
    "product_type": 1,
    "description": "vonage delivers the most innovative and complete cloud communications platform for enterprises and small businesses."
  },
  "product_category": {
    "id": 30,
    "name": "Communication App"
  }
}

Dev Docs

The API documentation created using postman

2 articles in this category.
Written by Yaroslav M.