Function WebhooksApiFp

Returns {
    adminCreateWebhook(groupId, appId, serviceId, body, options?) => Promise<((axios?, basePath?) => AxiosPromise<void>)>;
    adminDeleteWebhook(groupId, appId, serviceId, incomingWebhookId, options?) => Promise<((axios?, basePath?) => AxiosPromise<void>)>;
    adminGetWebhook(groupId, appId, serviceId, incomingWebhookId, options?) => Promise<((axios?, basePath?) => AxiosPromise<void>)>;
    adminListWebhooks(groupId, appId, serviceId, options?) => Promise<((axios?, basePath?) => AxiosPromise<any>)>;
    adminUpdateWebhook(groupId, appId, serviceId, incomingWebhookId, body, options?) => Promise<((axios?, basePath?) => AxiosPromise<void>)>;
}

• adminCreateWebhook:function

  • adminCreateWebhook(groupId, appId, serviceId, body, options?): Promise<((axios?, basePath?) => AxiosPromise<void>)>

  • Create 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.

    • body: any

      The webhook to create.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<void>)>

    Summary

    Create a webhook

    Throws

• adminDeleteWebhook:function

  • adminDeleteWebhook(groupId, appId, serviceId, incomingWebhookId, options?): Promise<((axios?, basePath?) => AxiosPromise<void>)>

  • 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 Promise<((axios?, basePath?) => AxiosPromise<void>)>

    Summary

    Delete a webhook

    Throws

• adminGetWebhook:function

  • adminGetWebhook(groupId, appId, serviceId, incomingWebhookId, options?): Promise<((axios?, basePath?) => AxiosPromise<void>)>

  • 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 Promise<((axios?, basePath?) => AxiosPromise<void>)>

    Summary

    Retrieve a webhook

    Throws

• adminListWebhooks:function

  • adminListWebhooks(groupId, appId, serviceId, options?): Promise<((axios?, basePath?) => AxiosPromise<any>)>

  • List webhooks.

    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.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<any>)>

    Summary

    List webhooks

    Throws

• adminUpdateWebhook:function

  • adminUpdateWebhook(groupId, appId, serviceId, incomingWebhookId, body, options?): Promise<((axios?, basePath?) => AxiosPromise<void>)>

  • 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 Promise<((axios?, basePath?) => AxiosPromise<void>)>

    Summary

    Update a webhook

    Throws