Function WebhooksApiAxiosParamCreator

  • WebhooksApi - axios parameter creator

    Parameters

    Returns {
        adminCreateWebhook: ((groupId, appId, serviceId, body, options?) => Promise<RequestArgs>);
        adminDeleteWebhook: ((groupId, appId, serviceId, incomingWebhookId, options?) => Promise<RequestArgs>);
        adminGetWebhook: ((groupId, appId, serviceId, incomingWebhookId, options?) => Promise<RequestArgs>);
        adminListWebhooks: ((groupId, appId, serviceId, options?) => Promise<RequestArgs>);
        adminUpdateWebhook: ((groupId, appId, serviceId, incomingWebhookId, body, options?) => Promise<RequestArgs>);
    }

    • adminCreateWebhook: ((groupId, appId, serviceId, body, options?) => Promise<RequestArgs>)
    • adminDeleteWebhook: ((groupId, appId, serviceId, incomingWebhookId, options?) => Promise<RequestArgs>)
        • (groupId, appId, serviceId, incomingWebhookId, options?): Promise<RequestArgs>
        • 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<RequestArgs>

          Summary

          Delete a webhook

          Throws

    • adminGetWebhook: ((groupId, appId, serviceId, incomingWebhookId, options?) => Promise<RequestArgs>)
        • (groupId, appId, serviceId, incomingWebhookId, options?): Promise<RequestArgs>
        • 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<RequestArgs>

          Summary

          Retrieve a webhook

          Throws

    • adminListWebhooks: ((groupId, appId, serviceId, options?) => Promise<RequestArgs>)
    • adminUpdateWebhook: ((groupId, appId, serviceId, incomingWebhookId, body, options?) => Promise<RequestArgs>)
        • (groupId, appId, serviceId, incomingWebhookId, body, options?): Promise<RequestArgs>
        • 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<RequestArgs>

          Summary

          Update a webhook

          Throws

    Export

Generated using TypeDoc