Create hook

curl --request POST \
  --url https://api.kajabi.com/v1/hooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/vnd.api+json' \
  --data '
{
  "data": {
    "type": "hooks",
    "attributes": {
      "target_url": "<string>",
      "resource_id": 123
    },
    "relationships": {
      "site": {}
    }
  }
}
'

import requests

url = "https://api.kajabi.com/v1/hooks"

payload = { "data": {
        "type": "hooks",
        "attributes": {
            "target_url": "<string>",
            "resource_id": 123
        },
        "relationships": { "site": {} }
    } }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/vnd.api+json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/vnd.api+json'},
  body: JSON.stringify({
    data: {
      type: 'hooks',
      attributes: {target_url: '<string>', resource_id: 123},
      relationships: {site: {}}
    }
  })
};

fetch('https://api.kajabi.com/v1/hooks', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.kajabi.com/v1/hooks",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'data' => [
        'type' => 'hooks',
        'attributes' => [
                'target_url' => '<string>',
                'resource_id' => 123
        ],
        'relationships' => [
                'site' => [
                                
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/vnd.api+json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.kajabi.com/v1/hooks"

	payload := strings.NewReader("{\n  \"data\": {\n    \"type\": \"hooks\",\n    \"attributes\": {\n      \"target_url\": \"<string>\",\n      \"resource_id\": 123\n    },\n    \"relationships\": {\n      \"site\": {}\n    }\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/vnd.api+json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.kajabi.com/v1/hooks")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/vnd.api+json")
  .body("{\n  \"data\": {\n    \"type\": \"hooks\",\n    \"attributes\": {\n      \"target_url\": \"<string>\",\n      \"resource_id\": 123\n    },\n    \"relationships\": {\n      \"site\": {}\n    }\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.kajabi.com/v1/hooks")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/vnd.api+json'
request.body = "{\n  \"data\": {\n    \"type\": \"hooks\",\n    \"attributes\": {\n      \"target_url\": \"<string>\",\n      \"resource_id\": 123\n    },\n    \"relationships\": {\n      \"site\": {}\n    }\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": "<string>",
    "type": "hooks",
    "attributes": {
      "target_url": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "resource_id": 123
    },
    "relationships": {
      "site": {
        "data": {
          "id": "<string>",
          "type": "<string>"
        }
      }
    }
  }
}

{
  "errors": [
    {
      "status": "<string>",
      "source": {
        "pointer": "<string>"
      },
      "title": "<string>",
      "detail": "<string>"
    }
  ]
}

{
  "errors": [
    {
      "status": "<string>",
      "source": {
        "pointer": "<string>"
      },
      "title": "<string>",
      "detail": "<string>"
    }
  ]
}

{
  "errors": [
    {
      "status": "<string>",
      "source": {
        "pointer": "<string>"
      },
      "title": "<string>",
      "detail": "<string>"
    }
  ]
}

Webhooks

Create hook

Creates a new webhook subscription

Request Body

The request must include:

data - parent object which includes the children/nested attributes:
target_url - The URL where webhook events will be sent
event - The type of event to subscribe to (see available events below), for example “tag_added”
resource_id (optional) - Specific resource ID to filter events for, for example the id of the Contact Tag. When the property is omitted, the webhook will be triggered for all events of the specified type, as a wildcard webhook.

Available Event Types

Event	Description	Required API Scopes
`purchase`	Customer makes a purchase	`view:purchases`
`payment_succeeded`	Payment transaction completes successfully	`view:transactions`
`order_created`	New order is created	`view:transactions`, `view:orders`
`form_submission`	Someone submits a form	`view:form_submissions`
`tag_added`	Tag is added to a contact	`view:contacts`
`tag_removed`	Tag is removed from a contact	`view:contacts`

Note: You can only create webhooks for events you have permission to access based on your API key scopes. For example to use tags you need the view:contacts scope, which is included in the account owner api key scope.

Sample Payloads

You can view sample webhook payloads for each event type:

GET /v1/hooks/purchase_sample
GET /v1/hooks/payment_succeeded_sample
GET /v1/hooks/order_created_sample
GET /v1/hooks/form_submission_sample
GET /v1/hooks/tag_added_sample
GET /v1/hooks/tag_removed_sample

Example request targeting a specific tag:

{
  "data": {
    "type": "hooks",
    "attributes": {
      "target_url": "https://example.com/webhook",
      "event": "tag_added",
      "resource_id": "123"
    },
    "relationships": {
      "site": {
        "data": {
          "id": "456",
          "type": "sites"
        }
      }
    }
  }
}

Example request using a wildcard webhook:

{
  "data": {
    "type": "hooks",
    "attributes": {
      "target_url": "https://example.com/webhook",
      "event": "tag_added"
    },
    "relationships": {
      "site": {
        "data": {
          "id": "456",
          "type": "sites"
        }
      }
    }
  }
}

Actual Payloads

The actual payloads are sent to the target_url as a POST request with the following JSON body:

{
  "id": "hash_id",
  "event": "tag_added",
  "payload": [],
}

The id is the ID of the resource that triggered the event. The event is the type of event that triggered the webhook. The payload is the actual payload of the event and the content will be similar to the sample payloads above.

POST

hooks

Create hook

curl --request POST \
  --url https://api.kajabi.com/v1/hooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/vnd.api+json' \
  --data '
{
  "data": {
    "type": "hooks",
    "attributes": {
      "target_url": "<string>",
      "resource_id": 123
    },
    "relationships": {
      "site": {}
    }
  }
}
'

import requests

url = "https://api.kajabi.com/v1/hooks"

payload = { "data": {
        "type": "hooks",
        "attributes": {
            "target_url": "<string>",
            "resource_id": 123
        },
        "relationships": { "site": {} }
    } }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/vnd.api+json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/vnd.api+json'},
  body: JSON.stringify({
    data: {
      type: 'hooks',
      attributes: {target_url: '<string>', resource_id: 123},
      relationships: {site: {}}
    }
  })
};

fetch('https://api.kajabi.com/v1/hooks', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.kajabi.com/v1/hooks",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'data' => [
        'type' => 'hooks',
        'attributes' => [
                'target_url' => '<string>',
                'resource_id' => 123
        ],
        'relationships' => [
                'site' => [
                                
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/vnd.api+json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.kajabi.com/v1/hooks"

	payload := strings.NewReader("{\n  \"data\": {\n    \"type\": \"hooks\",\n    \"attributes\": {\n      \"target_url\": \"<string>\",\n      \"resource_id\": 123\n    },\n    \"relationships\": {\n      \"site\": {}\n    }\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/vnd.api+json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.kajabi.com/v1/hooks")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/vnd.api+json")
  .body("{\n  \"data\": {\n    \"type\": \"hooks\",\n    \"attributes\": {\n      \"target_url\": \"<string>\",\n      \"resource_id\": 123\n    },\n    \"relationships\": {\n      \"site\": {}\n    }\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.kajabi.com/v1/hooks")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/vnd.api+json'
request.body = "{\n  \"data\": {\n    \"type\": \"hooks\",\n    \"attributes\": {\n      \"target_url\": \"<string>\",\n      \"resource_id\": 123\n    },\n    \"relationships\": {\n      \"site\": {}\n    }\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": "<string>",
    "type": "hooks",
    "attributes": {
      "target_url": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "resource_id": 123
    },
    "relationships": {
      "site": {
        "data": {
          "id": "<string>",
          "type": "<string>"
        }
      }
    }
  }
}

{
  "errors": [
    {
      "status": "<string>",
      "source": {
        "pointer": "<string>"
      },
      "title": "<string>",
      "detail": "<string>"
    }
  ]
}

{
  "errors": [
    {
      "status": "<string>",
      "source": {
        "pointer": "<string>"
      },
      "title": "<string>",
      "detail": "<string>"
    }
  ]
}

{
  "errors": [
    {
      "status": "<string>",
      "source": {
        "pointer": "<string>"
      },
      "title": "<string>",
      "detail": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/vnd.api+json

data

object

required

Show child attributes

Response

Success, webhook created

data

object

Show child attributes

List hooks

Hook details

Overview

Authentication

Blog posts

Contact Notes

Contact Tags

Contacts

Courses

Custom Fields

Customers

Forms

Webhooks

Kajabi Payments Payouts

Landing pages

Me

Offers

Orders

Podcasts

Products

Purchases

Sites

Transactions

Version

Create hook

Request Body

Available Event Types

Sample Payloads

Actual Payloads

Authorizations

Body

Response