COPS
Brand API

Send test notification

POST
/notifications/subscriptions/{id}/test

Send one test notification to a subscription's destination now and record the result as a delivery. Use it to check that a webhook or email address works, or to see how an event, such as the daily digest, looks. Pass idempotencyKey so a retry does not send twice.

Authorization

apiKeyAuth
headerx-api-key<token>

API key for authentication. Keys are prefixed with cops_.

Path Parameters

id*string

Subscription id from list_notification_subscriptions.

Match^nsub_.+[\s\S]*$

Request Body

application/json
  1. body
eventType?string

The event to send as the sample, from list_notification_event_types. Omit to use the subscription's first event. A digest sends the latest real report.

Value in"creator.joined_campaign""creator.added_to_campaign""creator.removed_from_campaign""creator.account_added""creator.account_linked_to_campaign""org.tiktok_ads_connected""creator.tiktok_account_ads_linked""org.meta_ads_connected""creator.meta_account_ads_linked""digest.daily"
idempotencyKey?string

Any unique string for this request. A retry with the same key returns the first result instead of doing it again.

Length1 <= length <= 200

Response Body

Response schema unavailable.

Example Request
curl -X POST 'https://cops.app/api/brand/notifications/subscriptions/string/test' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response200
Empty

Delete notification subscription DELETE

Delete a notification subscription and its delivery history. To pause notifications, use update_notification_subscription with enabled: false instead.

List notification deliveries GET

List recent notification sends, newest first, with status, attempts and error. Use it to find out if notifications were sent or why they failed. Filter by subscription, status or time.