traq.WebhookApi

All URIs are relative to https://q.trap.jp/api/v3

Method	HTTP request	Description
change_webhook_icon	PUT /webhooks/{webhookId}/icon	Webhookのアイコンを変更
create_webhook	POST /webhooks	Webhookを新規作成
delete_webhook	DELETE /webhooks/{webhookId}	Webhookを削除
edit_webhook	PATCH /webhooks/{webhookId}	Webhook情報を変更
get_webhook	GET /webhooks/{webhookId}	Webhook情報を取得
get_webhook_icon	GET /webhooks/{webhookId}/icon	Webhookのアイコンを取得
get_webhook_messages	GET /webhooks/{webhookId}/messages	Webhookの投稿メッセージのリストを取得
get_webhooks	GET /webhooks	Webhook情報のリストを取得します
post_webhook	POST /webhooks/{webhookId}	Webhookを送信

change_webhook_icon

change_webhook_icon(webhook_id, file)

Webhookのアイコンを変更

指定したWebhookのアイコン画像を変更します。

Example

OAuth Authentication (OAuth2):

import time
import traq
from traq.api import webhook_api
from pprint import pprint
# Defining the host is optional and defaults to https://q.trap.jp/api/v3
# See configuration.py for a list of all supported configuration parameters.
configuration = traq.Configuration(
    host = "https://q.trap.jp/api/v3"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure OAuth2 access token for authorization: OAuth2
configuration = traq.Configuration(
    host = "https://q.trap.jp/api/v3"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Enter a context with an instance of the API client
with traq.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = webhook_api.WebhookApi(api_client)
    webhook_id = "webhookId_example" # str | WebhookUUID
    file = open('/path/to/file', 'rb') # file_type | アイコン画像(1MBまでのpng, jpeg, gif)

    # example passing only required values which don't have defaults set
    try:
        # Webhookのアイコンを変更
        api_instance.change_webhook_icon(webhook_id, file)
    except traq.ApiException as e:
        print("Exception when calling WebhookApi->change_webhook_icon: %s\n" % e)

Parameters

Name	Type	Description	Notes
webhook_id	str	WebhookUUID
file	file_type	アイコン画像(1MBまでのpng, jpeg, gif)

Return type

void (empty response body)

Authorization

OAuth2

HTTP request headers

Content-Type: multipart/form-data
Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	No Content 変更されました。	-
400	Bad Request	-
404	Not Found Webhookが見つかりません。	-
413	Request Entity Too Large	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_webhook

Webhook create_webhook()

Webhookを新規作成

Webhookを新規作成します。 secretが空文字の場合、insecureウェブフックが作成されます。

Example

OAuth Authentication (OAuth2):

import time
import traq
from traq.api import webhook_api
from traq.model.webhook import Webhook
from traq.model.post_webhook_request import PostWebhookRequest
from pprint import pprint
# Defining the host is optional and defaults to https://q.trap.jp/api/v3
# See configuration.py for a list of all supported configuration parameters.
configuration = traq.Configuration(
    host = "https://q.trap.jp/api/v3"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure OAuth2 access token for authorization: OAuth2
configuration = traq.Configuration(
    host = "https://q.trap.jp/api/v3"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Enter a context with an instance of the API client
with traq.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = webhook_api.WebhookApi(api_client)
    post_webhook_request = PostWebhookRequest(
        name="name_example",
        description="description_example",
        channel_id="channel_id_example",
        secret="secret_example",
    ) # PostWebhookRequest |  (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Webhookを新規作成
        api_response = api_instance.create_webhook(post_webhook_request=post_webhook_request)
        pprint(api_response)
    except traq.ApiException as e:
        print("Exception when calling WebhookApi->create_webhook: %s\n" % e)

Parameters

Name	Type	Description	Notes
post_webhook_request	PostWebhookRequest		[optional]

Return type

Webhook

Authorization

OAuth2

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Created	-
400	Bad Request	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_webhook

delete_webhook(webhook_id)

Webhookを削除

指定したWebhookを削除します。 Webhookによって投稿されたメッセージは削除されません。

Example

OAuth Authentication (OAuth2):

import time
import traq
from traq.api import webhook_api
from pprint import pprint
# Defining the host is optional and defaults to https://q.trap.jp/api/v3
# See configuration.py for a list of all supported configuration parameters.
configuration = traq.Configuration(
    host = "https://q.trap.jp/api/v3"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure OAuth2 access token for authorization: OAuth2
configuration = traq.Configuration(
    host = "https://q.trap.jp/api/v3"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Enter a context with an instance of the API client
with traq.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = webhook_api.WebhookApi(api_client)
    webhook_id = "webhookId_example" # str | WebhookUUID

    # example passing only required values which don't have defaults set
    try:
        # Webhookを削除
        api_instance.delete_webhook(webhook_id)
    except traq.ApiException as e:
        print("Exception when calling WebhookApi->delete_webhook: %s\n" % e)

Parameters

Name	Type	Description	Notes
webhook_id	str	WebhookUUID

Return type

void (empty response body)

Authorization

OAuth2

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	No Content 削除されました。	-
404	Not Found Webhookが見つかりません。	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

edit_webhook

edit_webhook(webhook_id)

Webhook情報を変更

指定したWebhookの情報を変更します。

Example

OAuth Authentication (OAuth2):

import time
import traq
from traq.api import webhook_api
from traq.model.patch_webhook_request import PatchWebhookRequest
from pprint import pprint
# Defining the host is optional and defaults to https://q.trap.jp/api/v3
# See configuration.py for a list of all supported configuration parameters.
configuration = traq.Configuration(
    host = "https://q.trap.jp/api/v3"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure OAuth2 access token for authorization: OAuth2
configuration = traq.Configuration(
    host = "https://q.trap.jp/api/v3"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Enter a context with an instance of the API client
with traq.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = webhook_api.WebhookApi(api_client)
    webhook_id = "webhookId_example" # str | WebhookUUID
    patch_webhook_request = PatchWebhookRequest(
        name="name_example",
        description="description_example",
        channel_id="channel_id_example",
        secret="secret_example",
        owner_id="owner_id_example",
    ) # PatchWebhookRequest |  (optional)

    # example passing only required values which don't have defaults set
    try:
        # Webhook情報を変更
        api_instance.edit_webhook(webhook_id)
    except traq.ApiException as e:
        print("Exception when calling WebhookApi->edit_webhook: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Webhook情報を変更
        api_instance.edit_webhook(webhook_id, patch_webhook_request=patch_webhook_request)
    except traq.ApiException as e:
        print("Exception when calling WebhookApi->edit_webhook: %s\n" % e)

Parameters

Name	Type	Description	Notes
webhook_id	str	WebhookUUID
patch_webhook_request	PatchWebhookRequest		[optional]

Return type

void (empty response body)

Authorization

OAuth2

HTTP request headers

Content-Type: application/json
Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	No Content 編集できました。	-
400	Bad Request	-
404	Not Found Webhookが見つかりません。	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_webhook

Webhook get_webhook(webhook_id)

Webhook情報を取得

指定したWebhookの詳細を取得します。

Example

OAuth Authentication (OAuth2):

import time
import traq
from traq.api import webhook_api
from traq.model.webhook import Webhook
from pprint import pprint
# Defining the host is optional and defaults to https://q.trap.jp/api/v3
# See configuration.py for a list of all supported configuration parameters.
configuration = traq.Configuration(
    host = "https://q.trap.jp/api/v3"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure OAuth2 access token for authorization: OAuth2
configuration = traq.Configuration(
    host = "https://q.trap.jp/api/v3"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Enter a context with an instance of the API client
with traq.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = webhook_api.WebhookApi(api_client)
    webhook_id = "webhookId_example" # str | WebhookUUID

    # example passing only required values which don't have defaults set
    try:
        # Webhook情報を取得
        api_response = api_instance.get_webhook(webhook_id)
        pprint(api_response)
    except traq.ApiException as e:
        print("Exception when calling WebhookApi->get_webhook: %s\n" % e)

Parameters

Name	Type	Description	Notes
webhook_id	str	WebhookUUID

Return type

Webhook

Authorization

OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
404	Not Found Webhookが見つかりません。	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_webhook_icon

file_type get_webhook_icon(webhook_id)

Webhookのアイコンを取得

指定したWebhookのアイコン画像を取得します

Example

OAuth Authentication (OAuth2):

import time
import traq
from traq.api import webhook_api
from pprint import pprint
# Defining the host is optional and defaults to https://q.trap.jp/api/v3
# See configuration.py for a list of all supported configuration parameters.
configuration = traq.Configuration(
    host = "https://q.trap.jp/api/v3"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure OAuth2 access token for authorization: OAuth2
configuration = traq.Configuration(
    host = "https://q.trap.jp/api/v3"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Enter a context with an instance of the API client
with traq.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = webhook_api.WebhookApi(api_client)
    webhook_id = "webhookId_example" # str | WebhookUUID

    # example passing only required values which don't have defaults set
    try:
        # Webhookのアイコンを取得
        api_response = api_instance.get_webhook_icon(webhook_id)
        pprint(api_response)
    except traq.ApiException as e:
        print("Exception when calling WebhookApi->get_webhook_icon: %s\n" % e)

Parameters

Name	Type	Description	Notes
webhook_id	str	WebhookUUID

Return type

file_type

Authorization

OAuth2

HTTP request headers

Content-Type: Not defined
Accept: image/jpeg, image/gif, image/png

HTTP response details

Status code	Description	Response headers
200	OK	-
404	Not Found Webhookが見つかりません。	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_webhook_messages

[Message] get_webhook_messages(webhook_id)

Webhookの投稿メッセージのリストを取得

指定されたWebhookが投稿したメッセージのリストを返します。

Example

OAuth Authentication (OAuth2):

import time
import traq
from traq.api import webhook_api
from traq.model.message import Message
from pprint import pprint
# Defining the host is optional and defaults to https://q.trap.jp/api/v3
# See configuration.py for a list of all supported configuration parameters.
configuration = traq.Configuration(
    host = "https://q.trap.jp/api/v3"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure OAuth2 access token for authorization: OAuth2
configuration = traq.Configuration(
    host = "https://q.trap.jp/api/v3"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Enter a context with an instance of the API client
with traq.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = webhook_api.WebhookApi(api_client)
    webhook_id = "webhookId_example" # str | WebhookUUID
    limit = 50 # int | 取得する件数 (optional)
    offset = 150 # int | 取得するオフセット (optional) if omitted the server will use the default value of 0
    since = dateutil_parser('2016-10-12T11:00:00.000000Z') # datetime | 取得する時間範囲の開始日時 (optional) if omitted the server will use the default value of dateutil_parser('0000-01-01T00:00:00Z')
    until = dateutil_parser('2016-10-12T11:00:00.0000000Z') # datetime | 取得する時間範囲の終了日時 (optional)
    inclusive = False # bool | 範囲の端を含めるかどうか (optional) if omitted the server will use the default value of False
    order = "desc" # str | 昇順か降順か (optional) if omitted the server will use the default value of "desc"

    # example passing only required values which don't have defaults set
    try:
        # Webhookの投稿メッセージのリストを取得
        api_response = api_instance.get_webhook_messages(webhook_id)
        pprint(api_response)
    except traq.ApiException as e:
        print("Exception when calling WebhookApi->get_webhook_messages: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Webhookの投稿メッセージのリストを取得
        api_response = api_instance.get_webhook_messages(webhook_id, limit=limit, offset=offset, since=since, until=until, inclusive=inclusive, order=order)
        pprint(api_response)
    except traq.ApiException as e:
        print("Exception when calling WebhookApi->get_webhook_messages: %s\n" % e)

Parameters

Name	Type	Description	Notes
webhook_id	str	WebhookUUID
limit	int	取得する件数	[optional]
offset	int	取得するオフセット	[optional] if omitted the server will use the default value of 0
since	datetime	取得する時間範囲の開始日時	[optional] if omitted the server will use the default value of dateutil_parser('0000-01-01T00:00:00Z')
until	datetime	取得する時間範囲の終了日時	[optional]
inclusive	bool	範囲の端を含めるかどうか	[optional] if omitted the server will use the default value of False
order	str	昇順か降順か	[optional] if omitted the server will use the default value of "desc"

Return type

[Message]

Authorization

OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	* X-TRAQ-MORE -
400	Bad Request	-
404	Not Found Webhookが見つかりません。	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_webhooks

[Webhook] get_webhooks()

Webhook情報のリストを取得します

Webhookのリストを取得します。 allがtrueで無い場合は、自分がオーナーのWebhookのリストを返します。

Example

OAuth Authentication (OAuth2):

import time
import traq
from traq.api import webhook_api
from traq.model.webhook import Webhook
from pprint import pprint
# Defining the host is optional and defaults to https://q.trap.jp/api/v3
# See configuration.py for a list of all supported configuration parameters.
configuration = traq.Configuration(
    host = "https://q.trap.jp/api/v3"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure OAuth2 access token for authorization: OAuth2
configuration = traq.Configuration(
    host = "https://q.trap.jp/api/v3"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Enter a context with an instance of the API client
with traq.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = webhook_api.WebhookApi(api_client)
    all = False # bool | 全てのWebhookを取得します。権限が必要です。 (optional) if omitted the server will use the default value of False

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Webhook情報のリストを取得します
        api_response = api_instance.get_webhooks(all=all)
        pprint(api_response)
    except traq.ApiException as e:
        print("Exception when calling WebhookApi->get_webhooks: %s\n" % e)

Parameters

Name	Type	Description	Notes
all	bool	全てのWebhookを取得します。権限が必要です。	[optional] if omitted the server will use the default value of False

Return type

[Webhook]

Authorization

OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

post_webhook

post_webhook(webhook_id)

Webhookを送信

Webhookにメッセージを投稿します。 secureなウェブフックに対してはX-TRAQ-Signatureヘッダーが必須です。アーカイブされているチャンネルには投稿できません。

Example

OAuth Authentication (OAuth2):

import time
import traq
from traq.api import webhook_api
from pprint import pprint
# Defining the host is optional and defaults to https://q.trap.jp/api/v3
# See configuration.py for a list of all supported configuration parameters.
configuration = traq.Configuration(
    host = "https://q.trap.jp/api/v3"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure OAuth2 access token for authorization: OAuth2
configuration = traq.Configuration(
    host = "https://q.trap.jp/api/v3"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Enter a context with an instance of the API client
with traq.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = webhook_api.WebhookApi(api_client)
    webhook_id = "webhookId_example" # str | WebhookUUID
    x_traq_signature = "X-TRAQ-Signature_example" # str | リクエストボディシグネチャ(Secretが設定されている場合は必須) (optional)
    x_traq_channel_id = "X-TRAQ-Channel-Id_example" # str | 投稿先のチャンネルID(変更する場合) (optional)
    embed = 0 # int | メンション・チャンネルリンクを自動埋め込みする場合に1を指定する (optional) if omitted the server will use the default value of 0
    body = "body_example" # str |  (optional)

    # example passing only required values which don't have defaults set
    try:
        # Webhookを送信
        api_instance.post_webhook(webhook_id)
    except traq.ApiException as e:
        print("Exception when calling WebhookApi->post_webhook: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Webhookを送信
        api_instance.post_webhook(webhook_id, x_traq_signature=x_traq_signature, x_traq_channel_id=x_traq_channel_id, embed=embed, body=body)
    except traq.ApiException as e:
        print("Exception when calling WebhookApi->post_webhook: %s\n" % e)

Parameters

Name	Type	Description	Notes
webhook_id	str	WebhookUUID
x_traq_signature	str	リクエストボディシグネチャ(Secretが設定されている場合は必須)	[optional]
x_traq_channel_id	str	投稿先のチャンネルID(変更する場合)	[optional]
embed	int	メンション・チャンネルリンクを自動埋め込みする場合に1を指定する	[optional] if omitted the server will use the default value of 0
body	str		[optional]

Return type

void (empty response body)

Authorization

OAuth2

HTTP request headers

Content-Type: text/plain
Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	No Content	-
400	Bad Request	-
404	Not Found	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

WebhookApi.md

Latest commit

History

WebhookApi.md

File metadata and controls

traq.WebhookApi

change_webhook_icon

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

create_webhook

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_webhook

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

edit_webhook

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_webhook

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_webhook_icon

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_webhook_messages

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_webhooks

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

post_webhook

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details