Отправить тестовое уведомление

POST /webhook-subscriptions/{id}/test

Отправляет тестовое уведомление на URL, который указан в подписке.

Примеры запросов

cURL

Python

Nodejs

curl -X POST 'https://tasks.yandex.ru/api/v1/webhook-subscriptions/62ee14ada451956b21388859/test' \
     -H 'Authorization: OAuth PlaceYourRealOAuthToken_Here' \
     -H 'Content-Type: application/json'

import requests

url = "https://tasks.yandex.ru/api/v1/webhook-subscriptions/62ee14ada451956b21388859/test"
headers = {
  'Authorization': 'OAuth PlaceYourRealOAuthToken_Here',
  'Content-Type': 'application/json'
}
response = requests.post(url, headers=headers)

print(response.text)

var request = require('request');
var options = {
  'method': 'POST',
  'url': 'https://tasks.yandex.ru/api/v1/webhook-subscriptions/62ee14ada451956b21388859/test',
  'qs': {},
  'headers': {
    'Authorization': 'OAuth PlaceYourRealOAuthToken_Here',
    'Content-Type': 'application/json'
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

Path-параметры

Параметр

Описание

id*

string

Идентификатор подписки.

Заголовки

Заголовок	Описание
`Authorization`	API-токен для авторизации аккаунта. В качестве префикса добавьте `OAuth`.

Ответ

Если запрос выполнен успешно, сервер возвращает HTTP-статус выполнения операции: 200 OK или 404 Not Found.

Пример ответа

{
  "success": true,
  "responseReceivedAt": "2022-02-14T12:22:58",
  "errorType": "WRONG_STATUS_CODE",
  "originalStatusCode": 1,
  "uuids": [
    "uuid1",
    "uuid2",
    "uuid3",
    "uuid4",
    "uuid5"
  ]
}

Параметр	Описание
`success`	boolean Статус выполнения запроса. Принимает значение `true` или `false`.
`responseReceivedAt`	string Дата и время создания подписки (UTC) в формате ISO 8601 `YYYY-MM-DDThh:mm:ss[.sss]`.
`errorType`	string Тип ошибки. Возможные значения: `WRONG_STATUS_CODE` — неверный код состояния. `TOO_MANY_CONNECTIONS` — превышен лимит соединений. `REQUEST_TIMEOUT` — таймаут запроса. `CONNECTION_ERROR` — ошибка соединения. `INTERNAL_ERROR` — внутренняя ошибка. `UNKNOWN` — неизвестная ошибка.
`originalStatusCode**	integer Код статуса ответа с URL-адреса подписки.
`uuids`	array of strings Массив уникальных номеров события.

Была ли статья полезна?

Удалить подписку

Формат уведомлений