Webhook を取得

クライアントアプリケーションに関連付けられている Webhook 設定のリストを取得します。

GET /2/webhooks

Webhook を取得

cURL

curl --request GET \
  --url https://api.x.com/2/webhooks \
  --header 'Authorization: Bearer <token>'

200

{
  "data": [
    {
      "created_at": "2023-11-07T05:31:56Z",
      "id": "1146654567674912769",
      "url": "<string>",
      "valid": true
    }
  ],
  "errors": [
    {
      "title": "<string>",
      "type": "<string>",
      "detail": "<string>",
      "status": 123
    }
  ],
  "meta": {
    "result_count": 123
  }
}

承認

Authorization · string · header · 必須

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

クエリパラメータ

webhook_config.fields · enum<string>[]

表示する WebhookConfig フィールドを指定するカンマ区切りのリストです。 WebhookConfig オブジェクトで利用可能なフィールドです。

Minimum array length: 1

利用可能なオプション: created_at, id, url, valid

例:

["created_at", "id", "url", "valid"]

レスポンス

200

application/json

リクエストは成功しました。

data · object[]

Minimum array length: 1

Show child attributes

errors · object[]

Minimum array length: 1

IETF RFC 7807 (https://tools.ietf.org/html/rfc7807) で定義された HTTP Problem Details オブジェクト。

Option 1

Option 2

Option 3

Option 4

Option 5

Option 6

Option 7

Option 8

Option 9

Option 10

Option 11

Option 12

Option 13

Option 14

Option 15

Option 16

Option 17

Option 18

Show child attributes

meta · object

Show child attributes