APIs and webhooks will help streamline communication between your existing systems and PayDocker to improve efficiency. Before moving forward, we will have to understand some key terms:
| Term | What is it? |
| API | A system that lets one application (like your accounting software) ask another application (PayDocker) for data or to perform an action. |
| API Key | A unique, secret password that verifies your system is allowed to communicate with PayDocker. |
| Webhook |
A system that emables real-time updates and automation. It's an automated notification. You don't have to check PayDocker for changes constantly. |
| Webhook Endpoint | A specific and secure URL on your server where PayDocker sends its automated event notifications. |
Your PayDocker account would also have logs of your API triggers to track API events.
What you can do here
Webhooks
Webhooks are grouped by the core function they relate to. You can set up and manage all your webhooks at: https://dashboard.paydocker.com/integration-webhooks
You may also click on the headers (Push / Read / Pull) below to view the configuration steps.
| Category |
Push |
Read (You provide URL) |
Pull (You → PayDocker) |
| Token |
✅ |
✅ | |
| Booking |
✅ |
✅ | ✅ |
| Invoice |
|
✅ | |
| Checkout |
✅ |
✅ | |
| Authorisation |
✅ |
✅ |
Setting Up an Endpoint (Push/Read Methods)
1. To add an endpoint, click + Add endpoint.
2. Select the desired Category (e.g., Token) and the connection Method (Push or Read).
3. Once the endpoint is created, click the three dots (...) and select Update details.
4. Next, select the list of events to add to this endpoint from this drop down list. Click Add to finalise the list of events, and select the X button to remove the events if required.
Note: For the Read method, you must immediately provide a valid endpoint URL.
5. Lastly, select Update.
Pull Method (Booking Only)
1. Once you have selected the Pull method, you will need to provide the URL, username, and password. When successfully updated, the endpoint will be reflected on the dashboard.
2. Next, you will need to configure the details of this endpoint. Similarly, select the three dots and then update details.
3. You will be prompted to configure the Timezone, Frequency, and Schedule that PayDocker should use when attempting to retrieve data.
Manage webhook endpoints
For both push and read methods, you can manage the endpoints as such. To find the other options to manage your endpoints, click the three dots.
1. Set an expiry date for the API key
Click Expire to set the timer for the expiration of the authentication key and roll the API key.
(1) Expiration - user will set an expiration date for the authentication key.
- Now
- 1 hour
- 2 hours
- 24 hours
(2) Input password - is used for server-to-server communication
(3) Roll API key - is used for server-to-server communication
2. Disable the endpoint
Once disabled, the endpoint will turn from active to suspended status.
You can choose to activate the endpoint again by selecting Active.
3. Delete the endpoint
Select delete to remove the endpoint from the list. Once the endpoint has been removed, the list will return to default.
API
API Keys
Each API Key has been generated on your PayDocker account for each section above (Token, booking, invoice, check out, and authorization) and should be kept confidential. You can access your API keys by clicking the link below.
URL: https://dashboard.paydocker.com/integration-keys
Here are the details of this view:
(1) Roll IP key - Set the expiration of the key here. You can set the expiration time up to 24 hours.
(2) Reveal key - when the user clicks the reveal key, it will show the secret key of the authentication of the token keys.
(3) Publishable key - is used for accessing public data
(4) Secret key - is used for server-to-server communication
Logs
Lastly, you can see each trigger of the API. Logs contain information for each API push for your reference. Each push will be classified as succeed or fail, and the details of the entry.
Accessing Logs
1. Access this page by clicking on Integration (1), then Logs (2) in the left panel.
These categories are typically used to organize and manage log entries according to their status, making it easier for a user to monitor and troubleshoot the system or application to which these logs pertain.
| Category | Details |
| All | It shows all the transactions |
| Succeeded | Filters the logs to show only those that have completed successfully. |
| Failed | Filter the logs to show only the ones that did not complete successfully or encountered some error. |
In cases wherein you are searching for a specific API call, you are able to filter the search for your convenience.
- Logs Filter → you may narrow down the type of logs to NORMAL LOGS or SYNC LOGS.
- Date Range Filter → you may select a date range to narrow down your search.
- API Endpoint URL Filter → you can narrow your search by entering a specific endpoint url.
Below are the different status of the API call done.
- 200OK (1) — if this message is stated, that means that the API call done is all okay.
- 400ERR (2) — if this message is stated, that means that the API call has failed.
After selecting the specific API call, on the right-hand side of the page, you will be able to see the details of the call done. See the image below for your reference: