Knowledge Base - 2Checkout - Notifications and INS
Like

Notifications and INS


The Webhooks tab (previously "Notifications") in your account will allow you to set up the URL(s) to which you wish to receive Webhooks/INS posts, or review the successful and failed posts from the last 30 days for your account.

To set up your notification URL(s) click on the Webhooks tab in your account to be directed to the Settings page. On the Settings page you may then enter a Global URL to have all notifications sent to the same URL, or you may provide a specific URL for each notification type.

Below are instructions for setting the notification URL(s) for your account.

If you will be using a single URL to receive all available notifications:
  1. Enter your script URL in the Global URL field.
  2. Click the orange Apply button to the right of the Global URL field.
  3. To receive all notification types to that URL click the green Enable All Notifications link located above the Global URL field.
  4. Click the black Save Settings link located above the Global URL field or at the bottom of the page. NOTE: After clicking Save Changes the URL will no longer be visible in the Global URL field, but will be listed in the URL field for each notification type.
If you will be using a single URL to receive notifications, but you only wish to receive specific notifications:
  1. Enter your URL in the Global URL field. Important: When entering the URL(s) please ensure that you enter the entire domain path. Ex. http://www.yoursite.com/yourscript.php.
  2. Click the orange Apply button to the right of the Global URL field.
  3. Click the green Enable All Notifications link located under the Global URL field.
  4. Un-check the Enable button to the left of the URL field next to the notification type that you do not wish to receive. 
  5. Click the black Save Settings link located above the Global URL field or at the bottom of the page. Please note: After clicking Save Changes the URL will no longer be visible in the Global URL field, but will be listed in the URL field for each notification type you have elected to receive.
If you will be using different URL's based on the notification type:
  1. Enter the URL in the URL field for the notification type you wish to receive. Important: When entering the URL(s) please ensure that you enter the entire domain path. Ex. http://www.yoursite.com/yourscript.php.
  2. Place a check in the Enable box located to the left of the URL field for the Notification type you are setting up.
  3. Repeat steps 1 and 2 for all of the Notification types you wish to receive.
  4. Click the black Save Settings link located at the bottom left of the Settings page. 

By clicking the Success sub-tab you will be redirected to a log of all successful notifications for your account for the past 30 days. By default, this page will display the 20 most recent successful posts, and you will have the ability to increase the number of results displayed per page to 50 or 100. You will be able to view the Date and Time a successful notification was sent, Message Type, Notification Type, the URL to which the notification was sent, Last Attempted (Date and Time the last attempt for the notification was made) and the Invoice ID of the sale for which the notification was sent. You may resend any successful notification from this page by placing a check in the Resend box located to the left of the notification and then clicking the blue Resend button at the bottom left of the page. To resend all of the notifications listed on the page place a check in the Resend box located at the top left of the Notifications list and click the orange Resend button.

To view the parameters that were sent in the post, click the blue URL listed for the post you wish to review. A listing of the parameters that were sent will open in a light box so you may review the parameters and values that were sent in the post.

By clicking the Failed sub-tab you will be redirected to a log of all Failed notifications for your account for the past 30 days. By default, this page will display the 20 most recent Failed posts, and you will have the ability to increase the number of results displayed per page to 50 or 100. You will be able to view the Date and Time a Failed notification was sent, Message Type, Notification Type, the URL to which the notification was sent, Last Attempted (Date and Time the last attempt for the notification was made) and the Invoice ID of the sale for which the notification was sent. You may resend any Failed notification from this page by placing a check in the Resend box located to the left of the notification and then clicking the blue Resend button at the bottom left of the page. To resend all of the notifications listed on the page place a check in the Resend box located at the top left of the Notifications list and click the orange Resend button.

To view the parameters that were sent in the post click the blue URL listed for the post you wish to review. A listing of the parameters that were sent will open in a light box so you may review the parameters and values that were sent in the post.

Important note: Notifications listed in the Success and Failed logs will be listed on the report for 30 days and will then fall off the report.

To test this process create a Sandbox Account by going here.

  • [bill_city] => Columbus
  • [bill_country] => USA
  • [bill_postal_code] => 43228
  • [bill_state] => Ohio
  • [bill_street_address] => 1785 Acme Road
  • [bill_street_address2] => Apt 2
  • [cust_currency] => USD
  • [customer_email] => JohnDoe@2co.com
  • [customer_first_name] => Raphael
  • [customer_ip] => 192.168.2.37
  • [customer_ip_country] => USA
  • [customer_last_name] => Doe
  • [customer_name] => Raphael Doe
  • [customer_phone] => 6149212450
  • [invoice_id] => 100006320
  • [item_count] => 1
  • [item_cust_amount_1] => 10.25
  • [item_duration_1] => 1
  • [item_id_1] => 4562
  • [item_list_amount_1] => 9.99
  • [item_name_1] => New Account Signup
  • [item_rec_date_next_1] => N/A
  • [item_rec_install_billed_1] => 0
  • [item_rec_list_amount_1] => N/A
  • [item_rec_status_1] => N/A
  • [item_recurrence_1] => N/A
  • [item_type_1] => N/A
  • [item_usd_amount_1] => 49.00
  • [key_count] => 56
  • [list_currency] => USD
  • [md5_hash] => F9E2731C0F3F567D18D8647F6EA8D8DB
  • [message_description] => Test Message
  • [message_id] => 1
  • [message_type] => RECURRING_RESTARTED
  • [payment_type] => paypal
  • [recurring] => 0
  • [sale_date_placed] => 2004-03-1619:23:45
  • [sale_id] => 100006310
  • [ship_city] => Columbus
  • [ship_country] => USA
  • [ship_name] => Janie Doe
  • [ship_postal_code] => 43235
  • [ship_state] => OH
  • [ship_status] => A
  • [ship_street_address] => 134 Acme Lane
  • [ship_street_address2] => apt 3D
  • [ship_tracking_number] => 2323424234234-234-234
  • [timestamp] => 2009-04-0319:48:58
  • [vendor_id] => 1007
  • [vendor_order_id] => 1008OA

Was this article helpful?

Your feedback helps us improve our site.

Feedback

Please tell us how we can make this article more useful.

Characters Remaining: 255