Farcaster
Deploy onchain
Farcaster Hub API
Other SDKs
Neynar SDK
Update a webhook
Copy
Ask AI
curl --request PUT \
--url https://api.neynar.com/v2/farcaster/webhook/ \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "<string>",
"url": "<string>",
"webhook_id": "<string>",
"subscription": {
"cast.created": {
"exclude_author_fids": [
123
],
"author_fids": [
123
],
"mentioned_fids": [
123
],
"parent_urls": [
"<string>"
],
"root_parent_urls": [
"<string>"
],
"parent_hashes": [
"<string>"
],
"parent_author_fids": [
123
],
"text": "(?i)\\$degen",
"embeds": "\b(farcaster|neynar)\b",
"minimum_author_score": 0,
"embedded_cast_author_fids": [
123
],
"embedded_cast_hashes": [
"<string>"
]
},
"cast.deleted": {
"exclude_author_fids": [
123
],
"author_fids": [
123
],
"mentioned_fids": [
123
],
"parent_urls": [
"<string>"
],
"root_parent_urls": [
"<string>"
],
"parent_hashes": [
"<string>"
],
"parent_author_fids": [
123
],
"text": "(?i)\\$degen",
"embeds": "\b(farcaster|neynar)\b",
"minimum_author_score": 0,
"embedded_cast_author_fids": [
123
],
"embedded_cast_hashes": [
"<string>"
]
},
"user.created": {},
"user.updated": {
"fids": [
123
]
},
"follow.created": {
"fids": [
123
],
"target_fids": [
123
]
},
"follow.deleted": {
"fids": [
123
],
"target_fids": [
123
]
},
"reaction.created": {
"fids": [
123
],
"target_fids": [
123
],
"target_cast_hashes": [
"0x71d5225f77e0164388b1d4c120825f3a2c1f131c"
]
},
"reaction.deleted": {
"fids": [
123
],
"target_fids": [
123
],
"target_cast_hashes": [
"0x71d5225f77e0164388b1d4c120825f3a2c1f131c"
]
},
"trade.created": {
"fids": [
123
],
"minimum_trader_neynar_score": 0.5,
"minimum_token_amount_usdc": 1
}
}
}
'Copy
Ask AI
{
"message": "<string>",
"success": true,
"webhook": {
"object": "webhook",
"webhook_id": "<string>",
"developer_uuid": "<string>",
"target_url": "<string>",
"title": "<string>",
"secrets": [
{
"uid": "<string>",
"value": "<string>",
"expires_at": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"deleted_at": "<string>"
}
],
"description": "<string>",
"http_timeout": "<string>",
"rate_limit": 123,
"active": true,
"rate_limit_duration": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z",
"subscription": {
"object": "webhook_subscription",
"subscription_id": "<string>",
"filters": {
"cast.created": {
"exclude_author_fids": [
123
],
"author_fids": [
123
],
"mentioned_fids": [
123
],
"parent_urls": [
"<string>"
],
"root_parent_urls": [
"<string>"
],
"parent_hashes": [
"<string>"
],
"parent_author_fids": [
123
],
"text": "(?i)\\$degen",
"embeds": "\b(farcaster|neynar)\b",
"minimum_author_score": 0,
"embedded_cast_author_fids": [
123
],
"embedded_cast_hashes": [
"<string>"
]
},
"cast.deleted": {
"exclude_author_fids": [
123
],
"author_fids": [
123
],
"mentioned_fids": [
123
],
"parent_urls": [
"<string>"
],
"root_parent_urls": [
"<string>"
],
"parent_hashes": [
"<string>"
],
"parent_author_fids": [
123
],
"text": "(?i)\\$degen",
"embeds": "\b(farcaster|neynar)\b",
"minimum_author_score": 0,
"embedded_cast_author_fids": [
123
],
"embedded_cast_hashes": [
"<string>"
]
},
"user.created": {},
"user.updated": {
"fids": [
123
]
},
"follow.created": {
"fids": [
123
],
"target_fids": [
123
]
},
"follow.deleted": {
"fids": [
123
],
"target_fids": [
123
]
},
"reaction.created": {
"fids": [
123
],
"target_fids": [
123
],
"target_cast_hashes": [
"0x71d5225f77e0164388b1d4c120825f3a2c1f131c"
]
},
"reaction.deleted": {
"fids": [
123
],
"target_fids": [
123
],
"target_cast_hashes": [
"0x71d5225f77e0164388b1d4c120825f3a2c1f131c"
]
},
"trade.created": {
"fids": [
123
],
"minimum_trader_neynar_score": 0.5,
"minimum_token_amount_usdc": 1
}
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}
}Webhook
Update a webhook
Update a webhook
PUT
/
v2
/
farcaster
/
webhook
Update a webhook
Copy
Ask AI
curl --request PUT \
--url https://api.neynar.com/v2/farcaster/webhook/ \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "<string>",
"url": "<string>",
"webhook_id": "<string>",
"subscription": {
"cast.created": {
"exclude_author_fids": [
123
],
"author_fids": [
123
],
"mentioned_fids": [
123
],
"parent_urls": [
"<string>"
],
"root_parent_urls": [
"<string>"
],
"parent_hashes": [
"<string>"
],
"parent_author_fids": [
123
],
"text": "(?i)\\$degen",
"embeds": "\b(farcaster|neynar)\b",
"minimum_author_score": 0,
"embedded_cast_author_fids": [
123
],
"embedded_cast_hashes": [
"<string>"
]
},
"cast.deleted": {
"exclude_author_fids": [
123
],
"author_fids": [
123
],
"mentioned_fids": [
123
],
"parent_urls": [
"<string>"
],
"root_parent_urls": [
"<string>"
],
"parent_hashes": [
"<string>"
],
"parent_author_fids": [
123
],
"text": "(?i)\\$degen",
"embeds": "\b(farcaster|neynar)\b",
"minimum_author_score": 0,
"embedded_cast_author_fids": [
123
],
"embedded_cast_hashes": [
"<string>"
]
},
"user.created": {},
"user.updated": {
"fids": [
123
]
},
"follow.created": {
"fids": [
123
],
"target_fids": [
123
]
},
"follow.deleted": {
"fids": [
123
],
"target_fids": [
123
]
},
"reaction.created": {
"fids": [
123
],
"target_fids": [
123
],
"target_cast_hashes": [
"0x71d5225f77e0164388b1d4c120825f3a2c1f131c"
]
},
"reaction.deleted": {
"fids": [
123
],
"target_fids": [
123
],
"target_cast_hashes": [
"0x71d5225f77e0164388b1d4c120825f3a2c1f131c"
]
},
"trade.created": {
"fids": [
123
],
"minimum_trader_neynar_score": 0.5,
"minimum_token_amount_usdc": 1
}
}
}
'Copy
Ask AI
{
"message": "<string>",
"success": true,
"webhook": {
"object": "webhook",
"webhook_id": "<string>",
"developer_uuid": "<string>",
"target_url": "<string>",
"title": "<string>",
"secrets": [
{
"uid": "<string>",
"value": "<string>",
"expires_at": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"deleted_at": "<string>"
}
],
"description": "<string>",
"http_timeout": "<string>",
"rate_limit": 123,
"active": true,
"rate_limit_duration": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z",
"subscription": {
"object": "webhook_subscription",
"subscription_id": "<string>",
"filters": {
"cast.created": {
"exclude_author_fids": [
123
],
"author_fids": [
123
],
"mentioned_fids": [
123
],
"parent_urls": [
"<string>"
],
"root_parent_urls": [
"<string>"
],
"parent_hashes": [
"<string>"
],
"parent_author_fids": [
123
],
"text": "(?i)\\$degen",
"embeds": "\b(farcaster|neynar)\b",
"minimum_author_score": 0,
"embedded_cast_author_fids": [
123
],
"embedded_cast_hashes": [
"<string>"
]
},
"cast.deleted": {
"exclude_author_fids": [
123
],
"author_fids": [
123
],
"mentioned_fids": [
123
],
"parent_urls": [
"<string>"
],
"root_parent_urls": [
"<string>"
],
"parent_hashes": [
"<string>"
],
"parent_author_fids": [
123
],
"text": "(?i)\\$degen",
"embeds": "\b(farcaster|neynar)\b",
"minimum_author_score": 0,
"embedded_cast_author_fids": [
123
],
"embedded_cast_hashes": [
"<string>"
]
},
"user.created": {},
"user.updated": {
"fids": [
123
]
},
"follow.created": {
"fids": [
123
],
"target_fids": [
123
]
},
"follow.deleted": {
"fids": [
123
],
"target_fids": [
123
]
},
"reaction.created": {
"fids": [
123
],
"target_fids": [
123
],
"target_cast_hashes": [
"0x71d5225f77e0164388b1d4c120825f3a2c1f131c"
]
},
"reaction.deleted": {
"fids": [
123
],
"target_fids": [
123
],
"target_cast_hashes": [
"0x71d5225f77e0164388b1d4c120825f3a2c1f131c"
]
},
"trade.created": {
"fids": [
123
],
"minimum_trader_neynar_score": 0.5,
"minimum_token_amount_usdc": 1
}
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}
}Related tutorial: Programmatic webhooks
Authorizations
API key to authorize requests
Body
application/json
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Exclude casts that matches these authors. Note: This is applied as an AND operation against rest of the filters. Rest of the filters are bundled as an OR operation.
Regex pattern to match the text key of the cast. Note:
- Regex must be parsed by Go's RE2 engine (Test your expression here: https://www.lddgo.net/en/string/golangregex)
- Use backslashes to escape special characters. For example: (?i)\$degen should be written as (?i)\\$degen
Example:
"(?i)\\$degen"
Regex pattern to match the embeded_url (key embeds) of the cast. Note:
- Regex must be parsed by Go's RE2 engine (Test your expression here: https://www.lddgo.net/en/string/golangregex)
- Use backslashes to escape special characters. For example: \b(farcaster|neynar)\b should be written as \\b(farcaster|neynar)\\b
Example:
"\b(farcaster|neynar)\b"
Required range:
0 <= x <= 1Filter for casts that contain embedded casts authored by these FIDs
Filter for casts that quote/embed these specific cast hashes
Show child attributes
Show child attributes
Exclude casts that matches these authors. Note: This is applied as an AND operation against rest of the filters. Rest of the filters are bundled as an OR operation.
Regex pattern to match the text key of the cast. Note:
- Regex must be parsed by Go's RE2 engine (Test your expression here: https://www.lddgo.net/en/string/golangregex)
- Use backslashes to escape special characters. For example: (?i)\$degen should be written as (?i)\\$degen
Example:
"(?i)\\$degen"
Regex pattern to match the embeded_url (key embeds) of the cast. Note:
- Regex must be parsed by Go's RE2 engine (Test your expression here: https://www.lddgo.net/en/string/golangregex)
- Use backslashes to escape special characters. For example: \b(farcaster|neynar)\b should be written as \\b(farcaster|neynar)\\b
Example:
"\b(farcaster|neynar)\b"
Required range:
0 <= x <= 1Filter for casts that contain embedded casts authored by these FIDs
Filter for casts that quote/embed these specific cast hashes
Response
Success
Show child attributes
Show child attributes
Available options:
webhook Show child attributes
Show child attributes
Available options:
webhook_subscription Show child attributes
Show child attributes
Show child attributes
Show child attributes
Exclude casts that matches these authors. Note: This is applied as an AND operation against rest of the filters. Rest of the filters are bundled as an OR operation.
Regex pattern to match the text key of the cast. Note:
- Regex must be parsed by Go's RE2 engine (Test your expression here: https://www.lddgo.net/en/string/golangregex)
- Use backslashes to escape special characters. For example: (?i)\$degen should be written as (?i)\\$degen
Example:
"(?i)\\$degen"
Regex pattern to match the embeded_url (key embeds) of the cast. Note:
- Regex must be parsed by Go's RE2 engine (Test your expression here: https://www.lddgo.net/en/string/golangregex)
- Use backslashes to escape special characters. For example: \b(farcaster|neynar)\b should be written as \\b(farcaster|neynar)\\b
Example:
"\b(farcaster|neynar)\b"
Required range:
0 <= x <= 1Filter for casts that contain embedded casts authored by these FIDs
Filter for casts that quote/embed these specific cast hashes
Show child attributes
Show child attributes
Exclude casts that matches these authors. Note: This is applied as an AND operation against rest of the filters. Rest of the filters are bundled as an OR operation.
Regex pattern to match the text key of the cast. Note:
- Regex must be parsed by Go's RE2 engine (Test your expression here: https://www.lddgo.net/en/string/golangregex)
- Use backslashes to escape special characters. For example: (?i)\$degen should be written as (?i)\\$degen
Example:
"(?i)\\$degen"
Regex pattern to match the embeded_url (key embeds) of the cast. Note:
- Regex must be parsed by Go's RE2 engine (Test your expression here: https://www.lddgo.net/en/string/golangregex)
- Use backslashes to escape special characters. For example: \b(farcaster|neynar)\b should be written as \\b(farcaster|neynar)\\b
Example:
"\b(farcaster|neynar)\b"
Required range:
0 <= x <= 1Filter for casts that contain embedded casts authored by these FIDs
Filter for casts that quote/embed these specific cast hashes
Was this page helpful?
⌘I