POST
/
v1
/
webhooks
Create a new webhook
curl --request POST \
  --url https://api.cdp.coinbase.com/platform/v1/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "network_id": "base-sepolia",
  "event_type": "erc20_transfer",
  "event_type_filter": {
    "addresses": [
      "<string>"
    ],
    "wallet_id": "d91d652b-d020-48d4-bf19-5c5eb5e280c7"
  },
  "event_filters": [
    {
      "contract_address": "0xfc807D1bE4997e5C7B33E4d8D57e60c5b0f02B1a",
      "from_address": "0xfc807D1bE4997e5C7B33E4d8D57e60c5b0f02B1a",
      "to_address": "0xfc807D1bE4997e5C7B33E4d8D57e60c5b0f02B1a"
    }
  ],
  "notification_uri": "https://webhook.site/582307c2f9e1fac308a5f575",
  "signature_header": "your-custom-header"
}'
{
  "id": "582307c2f9e1fac308a5f575",
  "network_id": "base-sepolia",
  "event_type": "erc20_transfer",
  "event_type_filter": {
    "addresses": [
      "<string>"
    ],
    "wallet_id": "d91d652b-d020-48d4-bf19-5c5eb5e280c7"
  },
  "event_filters": [
    {
      "contract_address": "0xfc807D1bE4997e5C7B33E4d8D57e60c5b0f02B1a",
      "from_address": "0xfc807D1bE4997e5C7B33E4d8D57e60c5b0f02B1a",
      "to_address": "0xfc807D1bE4997e5C7B33E4d8D57e60c5b0f02B1a"
    }
  ],
  "notification_uri": "https://webhook.site/582307c2f9e1fac308a5f575",
  "created_at": "2024-07-21T17:32:28Z",
  "updated_at": "2024-07-21T17:32:28Z",
  "signature_header": "your-signature-header",
  "status": "active"
}

Authorizations

​
Authorization
string
header
required

Enter your JSON Web Token (JWT) here. Refer to the Generate JWT section of our Authentication docs for information on how to generate your Bearer Token.

Body

application/json
​
network_id
string
required

Blockchain network identifier.

Example:

"base-sepolia"

​
event_type
enum<string>
required
Available options:
unspecified,
erc20_transfer,
erc721_transfer,
wallet_activity,
smart_contract_event_activity
Example:

"erc20_transfer"

​
notification_uri
string
required

The URL to which the notifications will be sent

Example:

"https://webhook.site/582307c2f9e1fac308a5f575"

​
event_type_filter
object

The event_type_filter parameter specifies the criteria to filter events based on event type. Filter for wallet activity events. This filter allows the client to specify one or more wallet addresses to monitor for activities such as transactions, transfers, or other types of events that are associated with the specified addresses.

​
event_filters
object[]

Webhook will monitor all events that matches any one of the event filters.

​
signature_header
string

The custom header to be used for x-webhook-signature header on callbacks, so developers can verify the requests are coming from Coinbase.

Example:

"your-custom-header"

Response

The webhook

Webhook that is used for getting notifications when monitored events occur.

​
status
enum<string>
required

The status of the webhook.

Available options:
active,
inactive
Example:

"active"

​
id
string

Identifier of the webhook.

Example:

"582307c2f9e1fac308a5f575"

​
network_id
string

Blockchain network identifier.

Example:

"base-sepolia"

​
event_type
enum<string>
Available options:
unspecified,
erc20_transfer,
erc721_transfer,
wallet_activity,
smart_contract_event_activity
Example:

"erc20_transfer"

​
event_type_filter
object

The event_type_filter parameter specifies the criteria to filter events based on event type. Filter for wallet activity events. This filter allows the client to specify one or more wallet addresses to monitor for activities such as transactions, transfers, or other types of events that are associated with the specified addresses.

​
event_filters
object[]

Webhook will monitor all events that matches any one of the event filters.

​
notification_uri
string

The URL to which the notifications will be sent.

Example:

"https://webhook.site/582307c2f9e1fac308a5f575"

​
created_at
string<date-time>

The date and time the webhook was created.

Example:

"2024-07-21T17:32:28Z"

​
updated_at
string<date-time>

The date and time the webhook was last updated.

Example:

"2024-07-21T17:32:28Z"

​
signature_header
string

The header that will contain the signature of the webhook payload.

Example:

"your-signature-header"