Skip to main content
PATCH
/
beta
/
evm
/
subscriptions
/
webhooks
/
{webhookId}
curl --request PATCH \
  --url https://api.sim.dune.com/beta/evm/subscriptions/webhooks/{webhookId} \
  --header 'Content-Type: application/json' \
  --header 'X-Sim-Api-Key: <x-sim-api-key>' \
  --data '{
  "active": false
}'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "team_id": "<string>",
  "name": "<string>",
  "type": "transactions",
  "url": "<string>",
  "active": true,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "chain_ids": [
    123
  ],
  "transaction_type": "sender",
  "counterparty": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
  "activity_type": "approve",
  "asset_type": "native",
  "token_address": "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48"
}
Partially updates a webhook subscription’s configuration. You can modify any of the webhook’s properties without having to resend the entire configuration.
Only include the fields you want to update. All other properties will remain unchanged.
To manage subscribed addresses (add/remove), use the Update Addresses endpoint instead.

​
Example Use Cases

​
Pause a Webhook

To temporarily stop receiving webhook deliveries without deleting the webhook: 
{
  "active": false
}

​
Update Destination URL

{
  "url": "https://new-endpoint.example.com/webhooks"
}

​
Change Chain Filter

{
  "chain_ids": [1, 10, 8453]
}

​
Update Multiple Properties

You can update multiple properties in a single request: 
{
  "name": "Updated USDC Monitor",
  "active": true,
  "chain_ids": [1, 8453]
}

Headers

​
X-Sim-Api-Key
string
required

Used for authenticating requests. Provide an API key with a purpose of Sim API. See Authentication.

Path Parameters

​
webhookId
string<uuid>
required

The unique identifier of the webhook.

Body

application/json
​
name
string | null

Update the webhook name.

​
url
string<uri> | null

Update the webhook URL.

​
active
boolean | null

Enable or disable the webhook.

​
chain_ids
integer[] | null

Update the chain filter.

​
transaction_type
enum<string>

ONLY for 'transactions' type webhooks. Update transaction type filter. Cannot be used with other webhook types.

Available options:
sender,
receiver
​
counterparty
string | null

ONLY for 'transactions' type webhooks. Update counterparty filter.

​
activity_type
enum<string>

ONLY for 'activities' type webhooks. Update activity type filter. Cannot be used with other webhook types.

Available options:
approve,
mint,
burn,
receive,
send,
swap,
call
​
asset_type
enum<string>

Update asset type filter.

Available options:
native,
erc20,
erc721,
erc1155
​
token_address
string | null

Update token address filter.

Response

Webhook updated successfully.

​
id
string<uuid>

The unique identifier for the webhook.

​
team_id
string

The team ID that owns this webhook.

​
name
string

A descriptive name for the webhook.

​
type
enum<string>

The type of onchain event to subscribe to.

Available options:
transactions,
activities,
balances
​
url
string<uri>

The URL where webhook payloads will be sent.

​
active
boolean

Whether the webhook is currently active.

​
created_at
string<date-time>

When the webhook was created.

​
updated_at
string<date-time>

When the webhook was last updated.

​
chain_ids
integer[] | null

Filter events to specific chain IDs. If null, all supported chains are included.

​
transaction_type
enum<string>

For transaction webhooks, filter by sender or receiver.

Available options:
sender,
receiver
​
counterparty
string | null

Filter transactions by counterparty address.

Example:

"0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045"

​
activity_type
enum<string>

For activity webhooks, filter by specific activity type.

Available options:
approve,
mint,
burn,
receive,
send,
swap,
call
​
asset_type
enum<string>

Filter by asset type.

Available options:
native,
erc20,
erc721,
erc1155
​
token_address
string | null

Filter events to a specific token address.

Example:

"0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48"