Skip to content

Latest commit

 

History

History
141 lines (85 loc) · 3.79 KB

WebhooksApi.md

File metadata and controls

141 lines (85 loc) · 3.79 KB
Raw

\WebhooksApi

All URIs are relative to https://api.bombbomb.com/v2

Method HTTP request Description
AddWebHook Post /webhook Add Webhook
DeleteWebHook Delete /webhook/{hookId} Deletes Webhook
GetWebHooks Get /webhook/ Lists Webhooks
ListWebHookEvents Get /webhook/events Describe WebHook Events
SendWebhookExample Post /webhook/test Sends test Webhook

AddWebHook

BbWebHook AddWebHook(ctx, hookUrl) Add Webhook

Idempotently adds a Webhook url

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
hookUrl string The Url of your listener

Return type

BbWebHook

Authorization

BBOAuth2

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

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

DeleteWebHook

string DeleteWebHook(ctx, hookId) Deletes Webhook

Deletes a Webhook

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
hookId string The id of the webhook to delete

Return type

string

Authorization

BBOAuth2

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

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

GetWebHooks

[]BbWebHook GetWebHooks(ctx, ) Lists Webhooks

Lists all registered Webhooks

Required Parameters

This endpoint does not need any parameter.

Return type

[]BbWebHook

Authorization

BBOAuth2

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

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

ListWebHookEvents

ListWebHookEvents(ctx, ) Describe WebHook Events

Returns example Webhook events for each kind of possible event.

Required Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

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

SendWebhookExample

SendWebhookExample(ctx, ) Sends test Webhook

Triggers a test webhook to be sent to your endpoints.

Required Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

BBOAuth2

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

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