Skip to content

WebhooksApi.md

Latest commit

 

History

History
160 lines (87 loc) · 5.4 KB

WebhooksApi.md

File metadata and controls

160 lines (87 loc) · 5.4 KB

\WebhooksApi

All URIs are relative to https://zernio.com/api

Method HTTP request Description
create_webhook_settings POST /v1/webhooks/settings Create webhook
delete_webhook_settings DELETE /v1/webhooks/settings Delete webhook
get_webhook_settings GET /v1/webhooks/settings List webhooks
test_webhook POST /v1/webhooks/test Send test webhook
update_webhook_settings PUT /v1/webhooks/settings Update webhook

create_webhook_settings

models::UpdateWebhookSettings200Response create_webhook_settings(create_webhook_settings_request) Create webhook

Create a new webhook configuration. Maximum 10 webhooks per user. name, url and events are required. url must be a valid URL and events must contain at least one event. Whitespace is trimmed from url before validation. Webhooks are automatically disabled after 10 consecutive delivery failures.

Parameters

Name Type Description Required Notes
create_webhook_settings_request CreateWebhookSettingsRequest [required]

Return type

models::UpdateWebhookSettings200Response

Authorization

bearerAuth

HTTP request headers

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

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

delete_webhook_settings

models::UpdateYoutubeDefaultPlaylist200Response delete_webhook_settings(id) Delete webhook

Permanently delete a webhook configuration.

Parameters

Name Type Description Required Notes
id String Webhook ID to delete [required]

Return type

models::UpdateYoutubeDefaultPlaylist200Response

Authorization

bearerAuth

HTTP request headers

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

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

get_webhook_settings

models::GetWebhookSettings200Response get_webhook_settings() List webhooks

Retrieve all configured webhooks for the authenticated user. Supports up to 10 webhooks per user.

Parameters

This endpoint does not need any parameter.

Return type

models::GetWebhookSettings200Response

Authorization

bearerAuth

HTTP request headers

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

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

test_webhook

models::UnpublishPost200Response test_webhook(test_webhook_request) Send test webhook

Send a test webhook to verify your endpoint is configured correctly. The test payload includes event: "webhook.test" to distinguish it from real events.

Parameters

Name Type Description Required Notes
test_webhook_request TestWebhookRequest [required]

Return type

models::UnpublishPost200Response

Authorization

bearerAuth

HTTP request headers

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

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

update_webhook_settings

models::UpdateWebhookSettings200Response update_webhook_settings(update_webhook_settings_request) Update webhook

Update an existing webhook configuration. All fields except _id are optional; only provided fields will be updated. When provided, name must be 1-50 characters, url must be a valid URL, and events must contain at least one event. Whitespace is trimmed from url before validation. Webhooks are automatically disabled after 10 consecutive delivery failures.

Parameters

Name Type Description Required Notes
update_webhook_settings_request UpdateWebhookSettingsRequest [required]

Return type

models::UpdateWebhookSettings200Response

Authorization

bearerAuth

HTTP request headers

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

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