Interface WebhooksApiInterface

WebhooksApi - interface

Export

WebhooksApi

Hierarchy

  • WebhooksApiInterface

Implemented by

Methods

adminCreateWebhook adminDeleteWebhook adminGetWebhook adminListWebhooks adminUpdateWebhook

Methods

adminCreateWebhook

  • Create a webhook.

    Parameters

    Returns AxiosPromise<void>

    Summary

    Create a webhook

    Throws

    Memberof

    WebhooksApiInterface

adminDeleteWebhook

  • Delete a webhook.

    Parameters

    • groupId: any

      An Atlas Project/Group ID.

    • appId: any

      The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.

    • serviceId: any

      The unique `_id` value of a service.

    • incomingWebhookId: any

      The unique `_id` value of an incoming webhook

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Delete a webhook

    Throws

    Memberof

    WebhooksApiInterface

adminGetWebhook

  • Retrieve a webhook.

    Parameters

    • groupId: any

      An Atlas Project/Group ID.

    • appId: any

      The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.

    • serviceId: any

      The unique `_id` value of a service.

    • incomingWebhookId: any

      The unique `_id` value of an incoming webhook

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Retrieve a webhook

    Throws

    Memberof

    WebhooksApiInterface

adminListWebhooks

  • List webhooks.

    Parameters

    Returns AxiosPromise<any>

    Summary

    List webhooks

    Throws

    Memberof

    WebhooksApiInterface

adminUpdateWebhook

  • Update a webhook.

    Parameters

    • groupId: any

      An Atlas Project/Group ID.

    • appId: any

      The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.

    • serviceId: any

      The unique `_id` value of a service.

    • incomingWebhookId: any

      The unique `_id` value of an incoming webhook

    • body: any

      The updated state of the webhook.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Update a webhook

    Throws

    Memberof

    WebhooksApiInterface

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc