---
title: "Assignment removed"
method: POST
path: "assignment.canceled"
tags: ["Webhook Events"]
---

# Assignment removed

`POST assignment.canceled` (webhook)

An assignment was removed entirely: deleted by your team (`revoked`), unassigned before it started (`cleared`), or removed when its campaign ended or was deleted, the creator was archived, or the plan lapsed. `assignment` is its last state; periods it covered are no longer due.

## Headers

- `webhook-id` string, required
- `webhook-timestamp` string, required
- `webhook-signature` string, required

## Payload

- AssignmentCanceledWebhookEvent: An assignment was removed entirely: deleted by your team (`revoked`), unassigned before it started (`cleared`), or removed when its campaign ended or was deleted, the creator was archived, or the plan lapsed. `assignment` is its last state; periods it covered are no longer due.
  - `id` string, required: Event id; the `webhook-id` header. The same on every retry: dedupe on it.
  - `type` 'assignment.canceled', required
  - `timestamp` string, date-time, required: When the change happened
  - `organizationId` string, required
  - `actor` WebhookActor, required: Who caused the event: a member (`user`), an API key (`apiKeyId`), a creator, or viral.app itself (`system`); `surface` says where the change entered. Skip events your own API key caused to avoid loops.
    - `type` 'user' | 'api_key' | 'creator' | 'system', required
    - `surface` 'ui' | 'api' | 'copilot' | 'system', required
    - `userId` string, nullable, required
    - `apiKeyId` string, nullable, required
    - `impersonated` boolean, required
  - `data` object, required
    - `assignment` WebhookAssignment, required
      - `id` string, required
      - `orgCreatorId` string, required
      - `creatorUserId` string, required
      - `campaignId` string, required
      - `campaignName` string, required
      - `validFrom` string, date, required
      - `validUntil` string, date, nullable, required
      - `status` 'previous' | 'active' | 'upcoming', required
    - `reason` 'revoked' | 'cleared' | 'campaign_ended' | 'campaign_deleted' | 'creator_archived' | 'subscription_lapsed', required

## Acknowledgement `200`

Any 2xx within 15 seconds acknowledges the event. Anything else, a timeout or a redirect is retried (10 attempts over about 3 days); 410 disables the endpoint.

---

[API](https://skmtc.dev/viral/apis/viral-app-api.md) · [All operations](https://skmtc.dev/viral/apis/viral-app-api/llms.txt) · [OpenAPI document](https://skmtc.dev/viral/apis/viral-app-api/revisions/31e97fa79ef1?raw)