Create an integration hook - Tied

POST

/

api

/

v1

/

accounts

/

{account_id}

/

integrations

/

hooks

Create an integration hook

curl --request POST \
  --url https://app.tied.com/api/v1/accounts/{account_id}/integrations/hooks \
  --header 'Content-Type: application/json' \
  --header 'api_access_token: <api-key>' \
  --data '
{
  "app_id": 1,
  "inbox_id": 1,
  "status": 1,
  "settings": {}
}
'

import requests

url = "https://app.tied.com/api/v1/accounts/{account_id}/integrations/hooks"

payload = {
    "app_id": 1,
    "inbox_id": 1,
    "status": 1,
    "settings": {}
}
headers = {
    "api_access_token": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {api_access_token: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({app_id: 1, inbox_id: 1, status: 1, settings: {}})
};

fetch('https://app.tied.com/api/v1/accounts/{account_id}/integrations/hooks', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

require 'uri'
require 'net/http'

url = URI("https://app.tied.com/api/v1/accounts/{account_id}/integrations/hooks")

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

request = Net::HTTP::Post.new(url)
request["api_access_token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"app_id\": 1,\n  \"inbox_id\": 1,\n  \"status\": 1,\n  \"settings\": {}\n}"

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

package main

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

func main() {

	url := "https://app.tied.com/api/v1/accounts/{account_id}/integrations/hooks"

	payload := strings.NewReader("{\n  \"app_id\": 1,\n  \"inbox_id\": 1,\n  \"status\": 1,\n  \"settings\": {}\n}")

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

	req.Header.Add("api_access_token", "<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))

}

{
  "id": 9,
  "app_id": "webhook",
  "status": true,
  "inbox": {
    "id": 1,
    "name": "Apple Messages"
  },
  "account_id": 1,
  "hook_type": "account",
  "settings": {},
  "reference_id": null
}

{
  "error": "Resource could not be found"
}

Authorizations

api_access_token

string

header

required

This token can be obtained by visiting the profile page or via rails console. Provides access to endpoints based on the user permissions levels. This token can be saved by an external system when user is created via API, to perform activities on behalf of the user.

Path Parameters

id

integer

required

The numeric ID of the account

Body

application/json

app_id

integer

The ID of app for which integration hook is being created

Example:

1

inbox_id

integer

The inbox ID, if the hook is an inbox hook

Example:

1

status

integer

The status of the integration (0 for inactive, 1 for active)

Example:

1

settings

object

The settings required by the integration

Example:

{}

Response

Success

id

integer

The ID of the integration hook

app_id

string

The ID of the integration app

inbox_id

string

Inbox ID if its an Inbox integration

account_id

integer

Account ID of the integration

status

boolean

Whether the integration hook is enabled for the account

hook_type

enum<string>

Whether the hook is scoped to the whole account or to a single inbox.

Available options:

account,

inbox

settings

object

The associated settings for the integration

Create an integration hook

curl --request POST \
  --url https://app.tied.com/api/v1/accounts/{account_id}/integrations/hooks \
  --header 'Content-Type: application/json' \
  --header 'api_access_token: <api-key>' \
  --data '
{
  "app_id": 1,
  "inbox_id": 1,
  "status": 1,
  "settings": {}
}
'

import requests

url = "https://app.tied.com/api/v1/accounts/{account_id}/integrations/hooks"

payload = {
    "app_id": 1,
    "inbox_id": 1,
    "status": 1,
    "settings": {}
}
headers = {
    "api_access_token": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {api_access_token: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({app_id: 1, inbox_id: 1, status: 1, settings: {}})
};

fetch('https://app.tied.com/api/v1/accounts/{account_id}/integrations/hooks', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

require 'uri'
require 'net/http'

url = URI("https://app.tied.com/api/v1/accounts/{account_id}/integrations/hooks")

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

request = Net::HTTP::Post.new(url)
request["api_access_token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"app_id\": 1,\n  \"inbox_id\": 1,\n  \"status\": 1,\n  \"settings\": {}\n}"

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

package main

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

func main() {

	url := "https://app.tied.com/api/v1/accounts/{account_id}/integrations/hooks"

	payload := strings.NewReader("{\n  \"app_id\": 1,\n  \"inbox_id\": 1,\n  \"status\": 1,\n  \"settings\": {}\n}")

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

	req.Header.Add("api_access_token", "<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))

}

{
  "id": 9,
  "app_id": "webhook",
  "status": true,
  "inbox": {
    "id": 1,
    "name": "Apple Messages"
  },
  "account_id": 1,
  "hook_type": "account",
  "settings": {},
  "reference_id": null
}

{
  "error": "Resource could not be found"
}