> For the complete documentation index, see [llms.txt](/llms.txt).

- Snap

# snap_cancelBackgroundEvent

Cancel a background event created by [snap_scheduleBackgroundEvent](https://metamask-docs-git-docs-agent-wallet-s-66054a-consensys-ddffed67.vercel.app/snaps/reference/snaps-api/snap%5Fschedulebackgroundevent).

## Parameters

object

required

An object containing the parameters for the `snap_cancelBackgroundEvent`method.

### id

string

required

The ID of the background event to cancel.

## Returns

null

This method does not return any data, so the result is always `null`.

## Example

```ts
const id = await snap.request({
  method: 'snap_scheduleBackgroundEvent',
  params: {
    // ...
  },
})

// Later, when you want to cancel the background event:
snap.request({
  method: 'snap_cancelBackgroundEvent',
  params: { id },
})

```