Webhook

Добавить webhook

Примечание

Добавить можно не более 10 webhook’ов.

POST /v1.3/webhooks/


Тело запроса:

  • url - адрес, куда отправлять запрос при возникновения событий

После успешного выполнения возвращается созданный объект, описывающий запись о webhook’е.

id integer Идентификатор записи о webhook’е
url string Адрес, куда отправлять запрос при возникновения событий

Пример:

POST https://api.umnico.com/v1.3/webhooks

Body:

{
    "url": "https://your-website.com/api/webhooks/umnico"
}

Response:

{
    "id": 2,
    "url": "https://your-website.com/api/webhooks/umnico"
}

Получить webhook

GET /v1.3/webhooks/

После успешного выполнения возвращается массив, содержащий объекты - описывающие записи о webhook’ах (см. выше).


Пример:

GET https://api.umnico.com/v1.3/webhooks

Response:

[
    {
        "id": 1,
        "url": "https://your-another-website.com/api/webhooks/umnico"
    },
    {
        "id": 2,
        "url": "https://your-website.com/api/webhooks/umnico"
    }
]

Изменить адрес webhook’а

PUT /v1.3/webhooks/<id>

  • id - идентификатор записи о webhook’е

Тело запроса:

  • url - новый адрес, куда отправлять запрос при возникновении событий

После успешного выполнения возвращается объект, описывающий запись о webhook’е (см. выше).


Пример:

PUT https://api.umnico.com/v1.3/webhooks/2

Body:

{
    "url": "https://your-second-website.com/api/webhooks/umnico"
}

Response:

{
    "id": 2,
    "url": "https://your-second-website.com/api/webhooks/umnico"
}

Удалить webhook

DELETE /v1.3/webhooks/<id>

  • id - идентификатор записи о webhook’е

Пример:

DELETE https://api.umnico.com/v1.3/webhooks/2