How to enable webhook

How to enable webhook

If you are on a Sandbox/test account goto https://sandbox.onlinecheckwriter.com/manage/developer/index

To enable webhook, Go to  More >> Developer Panel (https://live.onlinecheckwriter.com/manage/developer/index)
Under the Webhook settings window, provide the necessary details.

1. Webhook url :  The url to receive the webhook
2. Serect key : Set any key to verify its going from Online Check Writer. (Not required unless you want to validate signature key).
3. Mail Tracking Status: If you want to get only mailed checks physical status for instance in_transit , delivered etc. (See the sample response attached).
4. Send Check Status Update: If you want to track the check statement status change. It will also provide you tracking code if it is a mail check after generating envelop (See the sample response attached).

To enable webhook for get paid by form, Go to Settings >> Developer Panel (https://live.onlinecheckwriter.com/manage/developer/index)
Under the Get Paid by Form Webhook window, provide the necessary details.

1. Webhook url :  The url to receive the webhook
2. Secret Key: Set any key to verify its going from Online Check Writer. (Not required unless you want to validate signature key).
3. Select an event: Select the events to receive webhook. (select checkboxes. When the event occur, you receive a webhook to the webhook url). 
     
Available events:
gpbf.check.created : Created when a check is created using GPBL (payment link). Sample file attached (getpaid_by_form_created.txt).
gpbf.check.updated : Created when a check created with GPBL (payment link) is updated. Sample file attached (getpaid_by_form_updated.txt)


Here is the possible status codes and descriptions that can be occured.
Status CodeShort Description

Full Description

1HTML-FORM-PENDINGCreate get Paid by form check
2HTML-FORM-VIEWEDGet paid by form check viewed
3HTML-FORM-REJECTEDGet paid by form check rejected
4HTML-FORM-ACCEPTEDGet paid by form check accepted
5HTML-FORM-TTPPrint on check paper & print on white paper
6HTML-FORM-PRINTEDMark As Printed
50GPBF-DD InitiatedGet paid by form direct deposit initiated
51GPBF-DD-CGet paid by form direct deposit completed
52GPBF-DD-FAILEDGet paid by form direct deposit failed