acquia-dam-sdk/dist/apis/webhooks/requests.d.ts

Interact with the Acquia DAM API

interface CreateAssetsWebhookParams {
    /** The URL to deliver webhook payloads to */
    delivery_url: string;
    /** The event type to monitor */
    event_type: AssetsEvent;
    /** HMAC signing key */
    secret_key?: string;
}
interface CreateWorkflowWebhookParams {
    /** The event name to monitor */
    event: WorkflowEvent;
    /** Where to send the event to */
    target: string;
}
interface EditAssetsWebhookParams {
    /** Whether the webhook is actively running */
    delivery_enabled?: boolean;
    /** The URL to deliver webhook payloads to */
    delivery_url?: string;
    /** The event type to monitor */
    event_type?: AssetsEvent;
    /** Webhook Configuration Id */
    id: string;
    /** List of fields to update (other fields included in the body will be ignored). If no patch parameter is sent, all fields included in request will be updated */
    patch?: AssetsWebhookPatch[];
    /** HMAC signing key */
    secret_key?: string;
}
interface ListAssetsWebhooksParams {
    /**
     * Numeric limit of the total number of results to retrieve
     *
     * Minimum: 1
     *
     * Maximum: 10
     *
     * @default 10
     */
    limit: number;
    /**
     * Starting position of query result set
     *
     * Minimum: 0
     *
     * @default 0
     */
    offset: number;
}
type AssetsEvent = 'asset_created' | 'asset_deleted' | 'asset_release_date_updated' | 'asset_expiration_date_updated' | 'asset_asset_groups_updated' | 'asset_categories_updated' | 'asset_tags_updated' | 'asset_version_added';
type WorkflowEvent = 'DELIVERABLE_STATUS_CHANGED' | 'PROJECT_CREATED';
type AssetsWebhookPatch = 'delivery_enabled' | 'delivery_url' | 'event_type' | 'secret_key';

export type { AssetsEvent, AssetsWebhookPatch, CreateAssetsWebhookParams, CreateWorkflowWebhookParams, EditAssetsWebhookParams, ListAssetsWebhooksParams, WorkflowEvent };