Admin — webhook subscribers

4 endpoints in this group. All paths are prefixed with /api/v1.

Endpoints in this group#

• GET /api/v1/admin/webhook-subscriptions — List Webhook Subscriptions
• POST /api/v1/admin/webhook-subscriptions — Create Webhook Subscription
• DELETE /api/v1/admin/webhook-subscriptions/{subscription_id} — Delete Webhook Subscription
• PATCH /api/v1/admin/webhook-subscriptions/{subscription_id} — Update Webhook Subscription

GET /api/v1/admin/webhook-subscriptions — List Webhook Subscriptions {#get-api-v1-admin-webhook-subscriptions}#

Parameters:

• authorization (header, string, optional)

Responses:

• 200 — Successful Response. Returns: ApiResponse_list_WebhookSubscriptionResponse__ — {data, meta}
• 422 — Validation Error. Returns: HTTPValidationError — {detail}

POST /api/v1/admin/webhook-subscriptions — Create Webhook Subscription {#post-api-v1-admin-webhook-subscriptions}#

Parameters:

• authorization (header, string, optional)

Body: WebhookSubscriptionCreate — {name, target_url, secret_vault_path, secret + 2 more}

Responses:

• 201 — Successful Response. Returns: ApiResponse_WebhookSubscriptionResponse_ — {data, meta}
• 422 — Validation Error. Returns: HTTPValidationError — {detail}

DELETE /api/v1/admin/webhook-subscriptions/{subscription_id} — Delete Webhook Subscription {#delete-api-v1-admin-webhook-subscriptions-subscription-id}#

Parameters:

• subscription_id (path, string, required)
• authorization (header, string, optional)

Responses:

• 200 — Successful Response. Returns: ApiResponse_dict_ — {data, meta}
• 422 — Validation Error. Returns: HTTPValidationError — {detail}

PATCH /api/v1/admin/webhook-subscriptions/{subscription_id} — Update Webhook Subscription {#patch-api-v1-admin-webhook-subscriptions-subscription-id}#

Parameters:

• subscription_id (path, string, required)
• authorization (header, string, optional)

Body: WebhookSubscriptionUpdate — {name, target_url, secret_vault_path, secret + 2 more}

Responses:

• 200 — Successful Response. Returns: ApiResponse_WebhookSubscriptionResponse_ — {data, meta}
• 422 — Validation Error. Returns: HTTPValidationError — {detail}