Ruby / New FreshBooks / Register for Callback
Back to Collection Items
require 'chilkat'
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
http = Chilkat::CkHttp.new()
# Use this online tool to generate code from sample JSON: Generate Code to Create JSON
# The following JSON is sent in the request body.
# {
# "callback": {
# "event": "invoice.create",
# "uri": "http://your_server.com/webhooks/ready"
# }
# }
json = Chilkat::CkJsonObject.new()
json.UpdateString("callback.event","invoice.create")
json.UpdateString("callback.uri","http://your_server.com/webhooks/ready")
# Adds the "Authorization: Bearer <access_token>" header.
http.put_AuthToken("<access_token>")
http.SetRequestHeader("Content-Type","application/json")
# resp is a CkHttpResponse
resp = http.PostJson3("https://api.freshbooks.com/events/account/{{accountId}}/events/callbacks","application/json",json)
if (http.get_LastMethodSuccess() == false)
print http.lastErrorText() + "\n";
exit
end
print resp.get_StatusCode().to_s() + "\n";
print resp.bodyStr() + "\n";
Curl Command
curl -X POST
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
-d '{
"callback": {
"event": "invoice.create",
"uri": "http://your_server.com/webhooks/ready"
}
}'
https://api.freshbooks.com/events/account/{{accountId}}/events/callbacks
Postman Collection Item JSON
{
"name": "Register for Callback",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"callback\": {\n \"event\": \"invoice.create\",\n \"uri\": \"http://your_server.com/webhooks/ready\"\n }\n}"
},
"url": {
"raw": "https://api.freshbooks.com/events/account/{{accountId}}/events/callbacks",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"events",
"account",
"{{accountId}}",
"events",
"callbacks"
]
},
"description": "## Events\t"
},
"response": [
]
}