Update webhook
Updates the configuration of an existing webhook endpoint. You can change the target URL, subscribed event types, description, or enabled/disabled status. Omitted fields are left unchanged.
Requirements
- Permission:
webhooks:write. - Project access: the path project must match the API key’s project.
- HTTP rate limit: 60 requests per 60 seconds per API key.
Authorizations
Project-bound Apollo Signal API key. Keys begin with ap_signal_ and must carry the permission shown on the operation.
Path Parameters
The project the webhook belongs to.
The unique identifier of the webhook to update.
Body
Fields to update. All fields are optional.
Webhook fields to replace; omitted fields remain unchanged.
Whether Signal should attempt new deliveries to this endpoint.
Replacement event subscription list.
email.sent, email.delivered, email.bounced, email.complained, email.opened, email.clicked, email.failed, email.rejected, email.delivery_delayed, email.suppressed, email.unsubscribed, email.read_engaged, webhook.test Replacement filter list.
Replacement endpoint name.
Replacement signing secret used for subsequent deliveries.
Replacement ordered transformation list.
Replacement public HTTPS delivery URL.
Response
Updated webhook endpoint.