Subscribe to Events

cURL

curl --request POST \
  --url https://app.talvin.ai/api/v1/subscribe \
  --header 'Content-Type: application/json' \
  --header 'X-TALVIN-API-KEY: <api-key>' \
  --header 'X-TALVIN-ORGANIZATION-ID: <api-key>' \
  --data '
{
  "hookUrl": "<string>"
}
'

import requests

url = "https://app.talvin.ai/api/v1/subscribe"

payload = { "hookUrl": "<string>" }
headers = {
    "X-TALVIN-API-KEY": "<api-key>",
    "X-TALVIN-ORGANIZATION-ID": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-TALVIN-API-KEY': '<api-key>',
    'X-TALVIN-ORGANIZATION-ID': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({hookUrl: '<string>'})
};

fetch('https://app.talvin.ai/api/v1/subscribe', 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://app.talvin.ai/api/v1/subscribe",
  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([
    'hookUrl' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-TALVIN-API-KEY: <api-key>",
    "X-TALVIN-ORGANIZATION-ID: <api-key>"
  ],
]);

$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://app.talvin.ai/api/v1/subscribe"

	payload := strings.NewReader("{\n  \"hookUrl\": \"<string>\"\n}")

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

	req.Header.Add("X-TALVIN-API-KEY", "<api-key>")
	req.Header.Add("X-TALVIN-ORGANIZATION-ID", "<api-key>")
	req.Header.Add("Content-Type", "application/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://app.talvin.ai/api/v1/subscribe")
  .header("X-TALVIN-API-KEY", "<api-key>")
  .header("X-TALVIN-ORGANIZATION-ID", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"hookUrl\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.talvin.ai/api/v1/subscribe")

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

request = Net::HTTP::Post.new(url)
request["X-TALVIN-API-KEY"] = '<api-key>'
request["X-TALVIN-ORGANIZATION-ID"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"hookUrl\": \"<string>\"\n}"

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "error": 123,
  "message": "<string>"
}

POST

cURL

curl --request POST \
  --url https://app.talvin.ai/api/v1/subscribe \
  --header 'Content-Type: application/json' \
  --header 'X-TALVIN-API-KEY: <api-key>' \
  --header 'X-TALVIN-ORGANIZATION-ID: <api-key>' \
  --data '
{
  "hookUrl": "<string>"
}
'

import requests

url = "https://app.talvin.ai/api/v1/subscribe"

payload = { "hookUrl": "<string>" }
headers = {
    "X-TALVIN-API-KEY": "<api-key>",
    "X-TALVIN-ORGANIZATION-ID": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-TALVIN-API-KEY': '<api-key>',
    'X-TALVIN-ORGANIZATION-ID': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({hookUrl: '<string>'})
};

fetch('https://app.talvin.ai/api/v1/subscribe', 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://app.talvin.ai/api/v1/subscribe",
  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([
    'hookUrl' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-TALVIN-API-KEY: <api-key>",
    "X-TALVIN-ORGANIZATION-ID: <api-key>"
  ],
]);

$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://app.talvin.ai/api/v1/subscribe"

	payload := strings.NewReader("{\n  \"hookUrl\": \"<string>\"\n}")

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

	req.Header.Add("X-TALVIN-API-KEY", "<api-key>")
	req.Header.Add("X-TALVIN-ORGANIZATION-ID", "<api-key>")
	req.Header.Add("Content-Type", "application/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://app.talvin.ai/api/v1/subscribe")
  .header("X-TALVIN-API-KEY", "<api-key>")
  .header("X-TALVIN-ORGANIZATION-ID", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"hookUrl\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.talvin.ai/api/v1/subscribe")

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

request = Net::HTTP::Post.new(url)
request["X-TALVIN-API-KEY"] = '<api-key>'
request["X-TALVIN-ORGANIZATION-ID"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"hookUrl\": \"<string>\"\n}"

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "error": 123,
  "message": "<string>"
}

Authorizations

X-TALVIN-API-KEY

string

header

required

X-TALVIN-ORGANIZATION-ID

string

header

required

Body

application/json

Subscription details

hookUrl

string<uri>

required

URL to receive webhook events

eventType

enum<string>

required

Type of event to subscribe to

Available options:

new_interview,

new_response,

candidate_status_changed

Response

Subscription created successfully

string<uuid>

required

Unique identifier for the subscription

API Documentation

Core

Subscriptions

Interviews

Responses

Authorizations

Body

Response