Skip to content

Latest commit

 

History

History
114 lines (74 loc) · 3.88 KB

WebhooksApi.md

File metadata and controls

114 lines (74 loc) · 3.88 KB

{{classname}}

All URIs are relative to https://slingshot.egoiapp.com/api/

Method HTTP request Description
AddWebHook Post /v2/webhooks Create new Webhook
ListWebHooks Get /v2/webhooks Get All Webhooks
RemoveWebHook Delete /v2/webhooks Remove Webhook

AddWebHook

WebhookIdResponse AddWebHook(ctx, optional) Create new Webhook

Create a new Webhook

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *WebhooksApiAddWebHookOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a WebhooksApiAddWebHookOpts struct

Name Type Description Notes
body optional.Interface of Body1 default response

Return type

WebhookIdResponse

Authorization

ApiKey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListWebHooks

[]GetWebhooksResponse ListWebHooks(ctx, optional) Get All Webhooks

Return all Webhooks defined by the user

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *WebhooksApiListWebHooksOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a WebhooksApiListWebHooksOpts struct

Name Type Description Notes
channel optional.String The channel of the groups. Can be `email` or `sms`, otherwise returns all groups.

Return type

[]GetWebhooksResponse

Authorization

ApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RemoveWebHook

RemoveWebHook(ctx, id, optional) Remove Webhook

Remove a Webhook

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string Id of the contact to be delete. Cannot be empty.
optional *WebhooksApiRemoveWebHookOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a WebhooksApiRemoveWebHookOpts struct

Name Type Description Notes

channel | optional.String| The channel of the Webhook. Can be `email` or `sms`, otherwise removes all the requested webhooks. |

Return type

(empty response body)

Authorization

ApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]