INinfomaniak
webhooks

Create an outgoing webhook

Create an outgoing webhook for a team.

Permissions

manage_webhooks for the team the webhook is in.

manage_others_outgoing_webhooks for the team the webhook is in if the user is different than the requester.

post/api/v4/hooks/outgoing

Request

  • Base URL
    https://api.infomaniak.com
  • URL
    https://api.infomaniak.com/api/v4/hooks/outgoing
  • Auth
    none declared

Request body

team_idstring required

The ID of the team that the webhook watchs

channel_idstring

The ID of a public channel that the webhook watchs

creator_idstring

The ID of the owner of the webhook if different than the requester.

descriptionstring

The description for this outgoing webhook

display_namestring required

The display name for this outgoing webhook

trigger_wordsstring[] required

List of words for the webhook to trigger on

trigger_wheninteger

When to trigger the webhook, 0 when a trigger word is present at all and 1 if the message starts with a trigger word

callback_urlsstring[] required

The URLs to POST the payloads to when the webhook is triggered

content_typestring

The format to POST the data in, either application/json or application/x-www-form-urlencoded

Response

Outgoing webhook creation successful

idstring

The unique identifier for this outgoing webhook

create_atinteger

The time in milliseconds a outgoing webhook was created

update_atinteger

The time in milliseconds a outgoing webhook was last updated

delete_atinteger

The time in milliseconds a outgoing webhook was deleted

creator_idstring

The Id of the user who created the webhook

team_idstring

The ID of the team that the webhook watchs

channel_idstring

The ID of a public channel that the webhook watchs

descriptionstring

The description for this outgoing webhook

display_namestring

The display name for this outgoing webhook

trigger_wordsstring[]

List of words for the webhook to trigger on

trigger_wheninteger

When to trigger the webhook, 0 when a trigger word is present at all and 1 if the message starts with a trigger word

callback_urlsstring[]

The URLs to POST the payloads to when the webhook is triggered

content_typestring

The format to POST the data in, either application/json or application/x-www-form-urlencoded

Changes

No recorded changes to this operation across all 40 revisions of this API.