Zendesk Event Received

POST

webhooks

{integration_id}

zendesk-event-received

curl --request POST \
  --url https://zeus-api.atlas.so/v1/webhooks/{integration_id}/zendesk-event-received \
  --header 'Content-Type: application/json' \
  --data '{}'

import requests

url = "https://zeus-api.atlas.so/v1/webhooks/{integration_id}/zendesk-event-received"

payload = {}
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({})
};

fetch('https://zeus-api.atlas.so/v1/webhooks/{integration_id}/zendesk-event-received', 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://zeus-api.atlas.so/v1/webhooks/{integration_id}/zendesk-event-received",
  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([
    
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/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://zeus-api.atlas.so/v1/webhooks/{integration_id}/zendesk-event-received"

	payload := strings.NewReader("{}")

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

	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://zeus-api.atlas.so/v1/webhooks/{integration_id}/zendesk-event-received")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://zeus-api.atlas.so/v1/webhooks/{integration_id}/zendesk-event-received")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{}"

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

{
  "message": {
    "id": "<string>",
    "role": "system",
    "sentAt": "2023-11-07T05:31:56Z",
    "type": "default",
    "text": "<string>",
    "attachments": [],
    "isSuggestion": false,
    "agentInfo": {
      "id": "<string>",
      "name": "<string>",
      "avatar": "<string>"
    }
  },
  "conversation": {
    "id": "<string>",
    "status": "open",
    "createdAt": "2023-11-07T05:31:56Z",
    "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "channel": "<string>",
    "firstUnreadMessageId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Path Parameters

integration_id

string<uuid>

required

Body

application/json

The body is of type Data · object.

Response

IngestMessageResult · object | null

Successful Response

message

ZeusMessage · object

required

Show child attributes

conversation

ZeusConversation · object

required

Show child attributes

Zendesk Event Received

curl --request POST \
  --url https://zeus-api.atlas.so/v1/webhooks/{integration_id}/zendesk-event-received \
  --header 'Content-Type: application/json' \
  --data '{}'

import requests

url = "https://zeus-api.atlas.so/v1/webhooks/{integration_id}/zendesk-event-received"

payload = {}
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({})
};

fetch('https://zeus-api.atlas.so/v1/webhooks/{integration_id}/zendesk-event-received', 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://zeus-api.atlas.so/v1/webhooks/{integration_id}/zendesk-event-received",
  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([
    
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/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://zeus-api.atlas.so/v1/webhooks/{integration_id}/zendesk-event-received"

	payload := strings.NewReader("{}")

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

	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://zeus-api.atlas.so/v1/webhooks/{integration_id}/zendesk-event-received")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://zeus-api.atlas.so/v1/webhooks/{integration_id}/zendesk-event-received")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{}"

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

{
  "message": {
    "id": "<string>",
    "role": "system",
    "sentAt": "2023-11-07T05:31:56Z",
    "type": "default",
    "text": "<string>",
    "attachments": [],
    "isSuggestion": false,
    "agentInfo": {
      "id": "<string>",
      "name": "<string>",
      "avatar": "<string>"
    }
  },
  "conversation": {
    "id": "<string>",
    "status": "open",
    "createdAt": "2023-11-07T05:31:56Z",
    "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "channel": "<string>",
    "firstUnreadMessageId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Overview

Guides

API Reference

Zendesk Event Received

Path Parameters

Body

Response