> ## Documentation Index
> Fetch the complete documentation index at: https://docs.sim.dune.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Update Webhook
> Modify an existing webhook subscription's configuration.
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](/evm/subscriptions/update-webhook-addresses) endpoint instead.
## Example Use Cases
### Pause a Webhook
To temporarily stop receiving webhook deliveries without deleting the webhook:
```json theme={null}
{
"active": false
}
```
### Update Destination URL
```json theme={null}
{
"url": "https://new-endpoint.example.com/webhooks"
}
```
### Change Chain Filter
```json theme={null}
{
"chain_ids": [1, 10, 8453]
}
```
### Update Multiple Properties
You can update multiple properties in a single request:
```json theme={null}
{
"name": "Updated USDC Monitor",
"active": true,
"chain_ids": [1, 8453]
}
```
## OpenAPI
````yaml /openapi.json PATCH /beta/evm/subscriptions/webhooks/{webhookId}
openapi: 3.0.3
info:
title: Sim API
description: >-
The Sim API by Dune provides real-time blockchain data across EVM and SVM
chains. Access token balances, transaction history, on-chain activity, DeFi
positions, NFT collectibles, token information, and webhook subscriptions
through a unified REST API.
version: 1.0.0
license:
name: ''
contact:
name: Dune Support
url: https://docs.sim.dune.com
email: support@dune.com
servers:
- url: https://api.sim.dune.com
security:
- ApiKeyAuth: []
tags:
- name: evm
description: EVM-compatible blockchain endpoints.
- name: svm
description: Solana/SVM blockchain endpoints.
- name: activity
description: On-chain activity feed.
- name: balances
description: Token balances (EVM and SVM).
- name: transactions
description: Transaction history (EVM and SVM).
- name: collectibles
description: NFT and ERC721/ERC1155 holdings.
- name: defi
description: DeFi protocol positions.
- name: supported-chains
description: Supported blockchain networks.
- name: token-info
description: Token metadata and pricing.
- name: token-holders
description: Token holder distribution.
- name: subscriptions
description: >-
Webhook subscription management for real-time on-chain event
notifications.
paths:
/beta/evm/subscriptions/webhooks/{webhookId}:
patch:
tags:
- evm
- subscriptions
summary: Update a webhook
description: >-
Partially updates a webhook subscription's configuration (name, URL,
status, chain filters, etc.). To manage addresses, use the PATCH
/webhooks/{webhookId}/addresses endpoint instead.
operationId: updateWebhook
parameters:
- name: webhookId
in: path
required: true
schema:
type: string
format: uuid
description: The unique identifier of the webhook.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateWebhook'
examples:
pause_webhook:
summary: Pause a webhook
value:
active: false
update_url:
summary: Update destination URL
value:
url: https://new-endpoint.example.com/webhooks
update_chains:
summary: Change chain filter
value:
chain_ids:
- 1
- 10
- 8453
responses:
'200':
description: Webhook updated successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/Webhook'
'400':
description: >-
Invalid request. This can occur when trying to set properties that
are incompatible with the webhook type.
content:
text/plain:
schema:
type: string
example: Webhook type balances cannot have activity_type
'429':
description: Rate Limit Exceeded - Too many requests.
content:
application/json:
schema:
$ref: '#/components/schemas/GatewayErrorResponse'
examples:
rateLimitExceeded:
value:
error: >-
Too many requests. Please contact sales@dune.com to
increase your limit.
components:
schemas:
UpdateWebhook:
type: object
properties:
name:
type: string
nullable: true
description: Update the webhook name.
url:
type: string
format: uri
nullable: true
description: Update the webhook URL.
active:
type: boolean
nullable: true
description: Enable or disable the webhook.
chain_ids:
type: array
items:
type: integer
format: int64
nullable: true
description: Update the chain filter.
transaction_type:
allOf:
- $ref: '#/components/schemas/TransactionType'
nullable: true
description: >-
ONLY for 'transactions' type webhooks. Update transaction type
filter. Cannot be used with other webhook types.
type: string
counterparty:
type: string
nullable: true
description: ONLY for 'transactions' type webhooks. Update counterparty filter.
activity_type:
allOf:
- $ref: '#/components/schemas/ActivityType'
nullable: true
description: >-
ONLY for 'activities' type webhooks. Update activity type filter.
Cannot be used with other webhook types.
type: string
asset_type:
allOf:
- $ref: '#/components/schemas/AssetType'
nullable: true
description: Update asset type filter.
type: string
token_address:
type: string
nullable: true
description: Update token address filter.
Webhook:
type: object
properties:
id:
type: string
format: uuid
description: The unique identifier for the webhook.
team_id:
type: string
description: The team ID that owns this webhook.
name:
type: string
description: A descriptive name for the webhook.
type:
$ref: '#/components/schemas/WebhookType'
url:
type: string
format: uri
description: The URL where webhook payloads will be sent.
active:
type: boolean
description: Whether the webhook is currently active.
created_at:
type: string
format: date-time
description: When the webhook was created.
updated_at:
type: string
format: date-time
description: When the webhook was last updated.
chain_ids:
type: array
items:
type: integer
format: int64
nullable: true
description: >-
Filter events to specific chain IDs. If null, all supported chains
are included.
transaction_type:
allOf:
- $ref: '#/components/schemas/TransactionType'
nullable: true
description: For transaction webhooks, filter by sender or receiver.
type: string
counterparty:
type: string
nullable: true
description: Filter transactions by counterparty address.
example: '0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045'
activity_type:
allOf:
- $ref: '#/components/schemas/ActivityType'
nullable: true
description: For activity webhooks, filter by specific activity type.
type: string
asset_type:
allOf:
- $ref: '#/components/schemas/AssetType'
nullable: true
description: Filter by asset type.
type: string
token_address:
type: string
nullable: true
description: Filter events to a specific token address.
example: '0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48'
GatewayErrorResponse:
type: object
description: >-
Error response from the API gateway. Returned for authentication,
permissions, rate-limiting, and quota errors.
properties:
error:
type: string
description: Error message.
required:
- error
TransactionType:
type: string
enum:
- sender
- receiver
description: >-
ONLY for 'transactions' type webhooks. Filter by whether the subscribed
address is the sender or receiver. Cannot be used with 'balances' or
'activities' webhook types.
ActivityType:
type: string
enum:
- approve
- mint
- burn
- receive
- send
- swap
- call
description: >-
ONLY for 'activities' type webhooks. Filter by specific activity types.
Cannot be used with 'balances' or 'transactions' webhook types.
AssetType:
type: string
enum:
- native
- erc20
- erc721
- erc1155
description: Filter by asset type.
WebhookType:
type: string
enum:
- transactions
- activities
- balances
description: The type of onchain event to subscribe to.
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: X-Sim-Api-Key
description: >-
API key for authentication. Obtain your key from the Dune dashboard at
sim.dune.com.
````