POST
/
farcaster
/
webhook
curl --request POST \
  --url https://api.neynar.com/v2/farcaster/webhook \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "name": "<string>",
  "url": "<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"
    },
    "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
      ]
    }
  }
}'
{
  "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"
    }
  }
}

Authorizations

x-api-key
string
header
default:NEYNAR_API_DOCS
required

API key to authorize requests

Body

application/json
name
string
required
url
string
required
subscription
object

Response

200
application/json
Created webhook
message
string
success
boolean
webhook
object