Skip to content

Latest commit

 

History

History
149 lines (95 loc) · 4.86 KB

WebhooksApi.md

File metadata and controls

149 lines (95 loc) · 4.86 KB
Raw

sib_api_v3_sdk.WebhooksApi

All URIs are relative to https://api.sendinblue.com/v3

Method HTTP request Description
CreateWebhook Post /webhooks Create a webhook
DeleteWebhook Delete /webhooks/{webhookId} Delete a webhook
GetWebhook Get /webhooks/{webhookId} Get a webhook details
GetWebhooks Get /webhooks Get all webhooks
UpdateWebhook Put /webhooks/{webhookId} Update a webhook

CreateWebhook

CreateModel CreateWebhook(ctx, body) Create a webhook

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
body CreateWebhook Values to create a webhook

Return type

CreateModel

Authorization

api-key, partner-key

HTTP request headers

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

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

DeleteWebhook

DeleteWebhook(ctx, webhookId) Delete a webhook

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
webhookId int64 Id of the webhook

Return type

(empty response body)

Authorization

api-key, partner-key

HTTP request headers

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

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

GetWebhook

GetWebhook GetWebhook(ctx, webhookId) Get a webhook details

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
webhookId int64 Id of the webhook

Return type

GetWebhook

Authorization

api-key, partner-key

HTTP request headers

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

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

GetWebhooks

GetWebhooks GetWebhooks(ctx, optional) Get all webhooks

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a WebhooksApiGetWebhooksOpts struct

Name Type Description Notes
type_ optional.String Filter on webhook type [default to transactional]

Return type

GetWebhooks

Authorization

api-key, partner-key

HTTP request headers

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

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

UpdateWebhook

UpdateWebhook(ctx, body, webhookId) Update a webhook

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
body UpdateWebhook Values to update a webhook
webhookId int64 Id of the webhook

Return type

(empty response body)

Authorization

api-key, partner-key

HTTP request headers

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

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