Home
API Reference
  1. Event API
  2. Events

Create a subscription

post
https://api.dev.cfx.to/v1/events/subscriptions

Creates a webhook subscription for the authenticated customer. The response carries the secret that signs each delivery: it is shown only here, so store it.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
topics
array of strings
required
length ≥ 1

The topics to receive, e.g. ["deposit.completed"]; ["*"] means every topic

topics*
uri
required
^https://

The HTTPS URL events are delivered to

filter
object

Only events whose payload matches this filter are delivered, e.g. {"data": {"amount": {"$gte": 100}}}

metadata
object

Key-value pairs to store with the subscription

Headers
string
Responses

Updated about 2 hours ago

Did this page help you?
Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 hours ago

Did this page help you?