Create a webhook endpoint

POST

/api/v1/webhook_endpoints

新しい webhook endpoint を作成する。レスポンスで平文 signing secret を
この 1 回だけ 返す (以降 public API からは取得できない)。
Team プラン以上が必要。event type の紐付けは本 endpoint ではサポートしない。

Request

Authorization

API Key

Add parameter in header

x-jicoo-api-key

Example:

x-jicoo-api-key: ********************

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Header Params

Body Params application/jsonRequired

Example

{
    "url": "string",
    "status": "disable",
    "description": "string",
    "scope": "team"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/api/v1/webhook_endpoints' \
--header 'X-Jicoo-Team;' \
--header 'x-jicoo-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "url": "string",
    "status": "disable",
    "description": "string",
    "scope": "team"
}'

Responses

🟢201

application/json

Created

Body

Example

{
    "data": {
        "uid": "string",
        "url": "string",
        "userId": "string",
        "status": "disable",
        "description": "string",
        "createdAt": "string",
        "updatedAt": "string",
        "scope": "team",
        "signingSecret": "string"
    }
}

🟠400InvalidParams

🟠401Unauthorized

🟠403Forbidden

🔴500InternalServerError

Modified at 2026-04-20 12:16:06

List webhook endpoints

Get a webhook endpoint