Webhook
Fetch a webhook
Farcaster API V2
- User
- Signer
- Cast
- Feed
- Reaction
- Notifications
- Channel
- Follows
- Storage
- Mini Apps
- Agents
- Fname
- Webhook
- Action
- Mute
- Block
- Ban
- Onchain
- Login
- Metrics
Onchain
Farcaster Hub API
- Info
- Casts
- Reactions
- Links
- UserData
- Fids
- Storage
- Usernames
- Verifications
- OnChainEvents
- Message
- HubEvents
Neynar SDK
- Getting Started with Neynar NodeJS SDK
- SDK v1 to v2 migration guide
Webhook
Fetch a webhook
Fetch a webhook
GET
/
farcaster
/
webhook
curl --request GET \
--url https://api.neynar.com/v2/farcaster/webhook \
--header 'x-api-key: <api-key>'
{
"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"
},
"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"
},
"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
]
},
"reaction.deleted": {
"fids": [
123
],
"target_fids": [
123
]
}
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}
}
Related tutorial: Programmatic webhooks
Authorizations
API key to authorize requests
Query Parameters
Response
200
application/json
Details of a webhook
Available options:
webhook
Available options:
webhook_subscription
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"
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"
Was this page helpful?
curl --request GET \
--url https://api.neynar.com/v2/farcaster/webhook \
--header 'x-api-key: <api-key>'
{
"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"
},
"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"
},
"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
]
},
"reaction.deleted": {
"fids": [
123
],
"target_fids": [
123
]
}
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}
}