Create webhook endpoint

The current 0xkey release supports ACTIVITY_UPDATES only. Balance and transaction webhook subscriptions are not enabled yet.

enum<string>

required

Enum options: ACTIVITY_TYPE_CREATE_WEBHOOK_ENDPOINT

string

required

Timestamp in milliseconds. Used to verify request liveness.

string

required

Unique identifier for the organization.

object

required

The webhook endpoint creation intent.

Show details

array

Event subscriptions to attach to this endpoint.

Show item details

object

required

Completed activity containing createWebhookEndpointResult.

Show activity result details

curl --request POST \
  --url https://api.0xkey.io/public/v1/submit/create_webhook_endpoint \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'X-Stamp: <string> (see Authorizations)' \
  --data '{
    "type": "ACTIVITY_TYPE_CREATE_WEBHOOK_ENDPOINT",
    "timestampMs": "1781250000000",
    "organizationId": "<organization-id>",
    "parameters": {
      "url": "https://example.com/webhooks/0xkey",
      "name": "Production activity webhook",
      "subscriptions": [
        {
          "eventType": "ACTIVITY_UPDATES",
          "filtersJson": "",
          "isActive": true
        }
      ]
    }
  }'

{
  "activity": {
    "id": "<activity-id>",
    "status": "ACTIVITY_STATUS_COMPLETED",
    "type": "ACTIVITY_TYPE_CREATE_WEBHOOK_ENDPOINT",
    "organizationId": "<organization-id>",
    "result": {
      "createWebhookEndpointResult": {
        "endpointId": "<endpoint-id>",
        "webhookEndpoint": {
          "endpointId": "<endpoint-id>",
          "organizationId": "<organization-id>",
          "url": "https://example.com/webhooks/0xkey",
          "name": "Production activity webhook",
          "isActive": true,
          "subscriptions": [
            {
              "eventType": "ACTIVITY_UPDATES",
              "filtersJson": "",
              "isActive": true
            }
          ]
        }
      }
    }
  }
}

Update webhook endpointUpdate an existing webhook endpoint's URL, name, or active status.

curl --request POST \
  --url https://api.0xkey.io/public/v1/submit/create_webhook_endpoint \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'X-Stamp: <string> (see Authorizations)' \
  --data '{
    "type": "ACTIVITY_TYPE_CREATE_WEBHOOK_ENDPOINT",
    "timestampMs": "1781250000000",
    "organizationId": "<organization-id>",
    "parameters": {
      "url": "https://example.com/webhooks/0xkey",
      "name": "Production activity webhook",
      "subscriptions": [
        {
          "eventType": "ACTIVITY_UPDATES",
          "filtersJson": "",
          "isActive": true
        }
      ]
    }
  }'

{
  "activity": {
    "id": "<activity-id>",
    "status": "ACTIVITY_STATUS_COMPLETED",
    "type": "ACTIVITY_TYPE_CREATE_WEBHOOK_ENDPOINT",
    "organizationId": "<organization-id>",
    "result": {
      "createWebhookEndpointResult": {
        "endpointId": "<endpoint-id>",
        "webhookEndpoint": {
          "endpointId": "<endpoint-id>",
          "organizationId": "<organization-id>",
          "url": "https://example.com/webhooks/0xkey",
          "name": "Production activity webhook",
          "isActive": true,
          "subscriptions": [
            {
              "eventType": "ACTIVITY_UPDATES",
              "filtersJson": "",
              "isActive": true
            }
          ]
        }
      }
    }
  }
}

Webhooks

Public API

Create webhook endpoint