No summary provided.
Constructs a new instance of the
WebhooksAPI class| Name | Type | Optional | Description |
|---|---|---|---|
| rest | REST | No | None |
Deletes a webhook
| Name | Type | Optional | Description |
|---|---|---|---|
| id | Snowflake | No | The id of the webhook to delete |
| options | Pick<RequestData, 'reason' | 'signal'> & { token?: string | undefined; } | Yes | The options for deleting the webhook |
Deletes an associated message from a webhook
| Name | Type | Optional | Description |
|---|---|---|---|
| id | Snowflake | No | The id of the webhook |
| token | string | No | The token of the webhook |
| messageId | Snowflake | No | The id of the message to delete |
| query | { thread_id?: Snowflake; } | Yes | The options for deleting the message |
| options | Pick<RequestData, 'signal'> | Yes | The options for deleting the message |
Edits a webhook
| Name | Type | Optional | Description |
|---|---|---|---|
| id | Snowflake | No | The id of the webhook to edit |
| body | RESTPatchAPIWebhookJSONBody | No | The new webhook data |
| options | Pick<RequestData, 'reason' | 'signal'> & { token?: string | undefined; } | Yes | The options for editing the webhook |
Edits an associated message from a webhook
| Name | Type | Optional | Description |
|---|---|---|---|
| id | Snowflake | No | The id of the webhook |
| token | string | No | The token of the webhook |
| messageId | Snowflake | No | The id of the message to edit |
| body | RESTPatchAPIWebhookWithTokenMessageJSONBody & { files?: RawFile[]; thread_id?: string; } | No | The data for editing the message |
| options | Pick<RequestData, 'signal'> | Yes | The options for editing the message |
Executes a webhook and returns the created message
| Name | Type | Optional | Description |
|---|---|---|---|
| id | Snowflake | No | The id of the webhook |
| token | string | No | The token of the webhook |
| body | RESTPostAPIWebhookWithTokenJSONBody & RESTPostAPIWebhookWithTokenQuery & { files?: RawFile[]; wait: true; } | No | The data for executing the webhook |
| options | Pick<RequestData, 'signal'> | Yes | The options for executing the webhook |
Executes a github webhook
| Name | Type | Optional | Description |
|---|---|---|---|
| id | Snowflake | No | The id of the webhook |
| token | string | No | The token of the webhook |
| body | unknown | No | The data for executing the webhook |
| query | RESTPostAPIWebhookWithTokenGitHubQuery | Yes | The options for executing the webhook |
| options | Pick<RequestData, 'signal'> | Yes | The options for executing the webhook |
Executes a slack webhook
| Name | Type | Optional | Description |
|---|---|---|---|
| id | Snowflake | No | The id of the webhook |
| token | string | No | The token of the webhook |
| body | unknown | No | The data for executing the webhook |
| query | RESTPostAPIWebhookWithTokenSlackQuery | Yes | The query options for executing the webhook |
| options | Pick<RequestData, 'signal'> | Yes | The options for executing the webhook |
Fetches a webhook
| Name | Type | Optional | Description |
|---|---|---|---|
| id | Snowflake | No | The id of the webhook |
| options | Pick<RequestData, 'signal'> & { token?: string | undefined; } | Yes | The options for fetching the webhook |
Fetches an associated message from a webhook
| Name | Type | Optional | Description |
|---|---|---|---|
| id | Snowflake | No | The id of the webhook |
| token | string | No | The token of the webhook |
| messageId | Snowflake | No | The id of the message to fetch |
| query | RESTGetAPIWebhookWithTokenMessageQuery | Yes | The query options for fetching the message |
| options | Pick<RequestData, 'signal'> | Yes | The options for fetching the message |