Notification channels
Configure project email and webhook destinations, test delivery, and link channels to schedules.
Loading documentation…
Powered by heyo
Notification channels deliver schedule results by email or webhook.
For mail, endpoints contains one to five email addresses. For webhook, it contains one to five validated webhook URLs and can include up to five request headers.
Detail responses mask URL user information and return request-header values as
[redacted]. Do not expect to retrieve stored header secrets.
Create accepts active, paused, or error status. Updates can set active or paused; service delivery can report an error state.
Schedules refer to channels by ID. The resolve operation accepts up to 50 IDs and returns matching channels from the key's project in input order. Missing or cross-project IDs are omitted.
A channel cannot be deleted while a schedule references it. Use the test-run action to attempt delivery and create a delivery message that can be inspected through the Messages API.
List filters support name, channel_type, and status.
Required scopes are v1.notification-channels:read, v1.notification-channels:write, and v1.notification-channels:delete.