Webhook Documentation

Webhooks allow real-time communication between systems.

Webhooks are used to synchronize disparate systems by publishing automated messages with predefined payloads that can be interpreted by integrated systems. They allow real-time communication between applications, enabling instant updates and data sharing without the need for continuous polling.

CoinSub webhooks provide notifications when specific actions occur on your account, such as when a customer subscribes to a product, purchases a one-off product, makes a payment, or cancels a subscription. By setting up webhooks, you can automate processes and keep your systems in sync with CoinSub in real-time.

How to Use the Webhooks

1. Sign into CoinSub

   • Sign into or create a new account by connecting your wallet to CoinSub.

2. Navigate to Merchant Settings

   • For new users: After signing in, you will be redirected to the merchant settings page.

   • For existing users: From the dashboard, select the merchant settings located on the sidebar.

3. Input Webhook URL

   • Input your webhook URL and other merchant details in the settings.

Webhook Triggers

The webhook is triggered during the following actions:

• When a customer subscribes to a product.

• When a customer purchases a one-off product.

• When a customer makes a payment.

• When a customer cancels a subscription.

Data Sent by the Webhook

Subscription

When a subscriber subscribes to a product, the webhook sends the following data:

{
  "type": "subscribe",
  "subscriber_id": "ec2fda4a-1982-4c45-b4cf-40447901ee03",
  "subscription_product_id": 7357,
  "subscription_product_name": "Test 127",
  "custom_field_values": null,
  "metadata": {
    "subscription_data": {
      "created_on": "2024-06-04T13:16:14.773264+03:00",
      "duration_days": 30,
      "last_payment_processed": "2024-06-04T00:00:00Z",
      "next_payment_due": "2024-07-04T00:00:00Z",
      "start_date": "2024-06-04T00:00:00Z",
      "status": "active",
      "subscription_product_id": 7357
    },
    "transaction_id": 97
  },
  "subscription_date": "2024-06-04T13:16:59.431238Z"
}

Fields:

• type: "subscribe" (Type of action being executed)

• subscriber_id: Unique identifier of the subscriber

• subscription_product_id: ID of the subscribed product

• subscription_product_name: Name of the subscribed product

• custom_field_values: Custom field values (if any)

• metadata: Additional metadata containing:

  • subscription_data:

    • created_on: Creation date of the subscription

    • duration_days: Duration of the subscription in days

    • last_payment_processed: Date of the last payment processed

    • next_payment_due: Date when the next payment is due

    • start_date: Start date of the subscription

    • status: Current status of the subscription

    • subscription_product_id: ID of the subscription product

  • transaction_id: ID of the transaction

• subscription_date: Date and time when the subscription was made

Payment

When a subscriber makes a payment, the webhook sends the following data:

{
  "type": "payment",
  "subscriber_id": "ec2fda4a-1982-4c45-b4cf-40447901ee03",
  "price_usd": 1,
  "subscription_product_id": 7357,
  "subscription_product_name": "Test 127",
  "custom_field_values": null,
  "metadata": {
    "payment_data": {
      "created_on": "2024-06-04T13:16:14.773264+03:00",
      "merchant_id": "2aeae52a-c915-4dc0-a78b-7d5ee9276015",
      "payment_processed": "2024-06-04T00:00:00Z",
      "price_usd": 1,
      "subscriber_id": "ec2fda4a-1982-4c45-b4cf-40447901ee03",
      "subscription_product_id": 7357
    },
    "transaction_id": 97
  },
  "payment_date": "2024-06-04T13:16:59.938381Z"
}

Fields:

• type: "payment" (Type of action being executed)

• subscriber_id: Unique identifier of the subscriber

• price_usd: Payment amount in USD

• subscription_product_id: ID of the subscription product

• subscription_product_name: Name of the subscription product

• custom_field_values: Custom field values (if any)

• metadata: Additional metadata containing:

  • payment_data:

    • created_on: Creation date of the payment record

    • merchant_id: Unique identifier of the merchant

    • payment_processed: Date when the payment was processed

    • price_usd: Payment amount in USD

    • subscriber_id: Unique identifier of the subscriber

    • subscription_product_id: ID of the subscription product

  • transaction_id: ID of the transaction

• payment_date: Date and time when the payment was made

Cancellation

When a subscriber cancels a subscription, the webhook sends the following data:

{
 "type": "cancelled",
  "subscriber_id": "ec2fda4a-1982-4c45-b4cf-40447901ee03",
  "subscription_product_id": 7359,
  "subscription_product_name": "Product 129",
  "custom_field_values": null,
  "metadata": {
    "cancelled_data": {
      "merchant_id": "2aeae52a-c915-4dc0-a78b-7d5ee9276015",
      "payment_processed": "2024-06-10T11:41:17.474419-04:00",
      "subscriber_id": "ec2fda4a-1982-4c45-b4cf-40447901ee03",
      "subscription_product_id": 7359
    }
  },
  "cancelled_date": "2024-06-10T11:41:17.49797Z"
}

Fields:

• type: "cancelled" (Type of action being executed)

• subscriber_id: Unique identifier of the subscriber

• subscription_product_id: ID of the subscription product

• subscription_product_name: Name of the subscription product

• custom_field_values: Custom field values (if any)

• metadata: Additional metadata containing:

  • cancelled_data:

    • merchant_id: Unique identifier of the merchant

    • payment_processed: Date when the payment was processed

    • subscriber_id: Unique identifier of the subscriber

    • subscription_product_id: ID of the subscription product

• cancelled_date: Date and time when the subscription was canceled

Retry Mechanism

If the webhook fails to deliver the data, it will retry up to 5 times, with each retry occurring every 5-10 minutes.

Conclusion

This documentation outlines how to use the webhook and the data it sends for different subscriber actions. Ensure you set your webhook URL in the merchant settings on the dashboard to receive these notifications.