Skip to main content
POST
/
webhooks
Create webhook
curl --request POST \
  --url https://api.conduit.financial/webhooks \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --header 'X-API-Secret: <api-key>' \
  --data '
{
  "url": "<string>",
  "events": [],
  "organizationId": "client_2ofTA13AD0xBtbEvBl20aEb1hEu"
}
'
{
  "url": "<string>",
  "events": [],
  "id": "whk_2ofTA13AD0xBtbEvBl20aEb1hEu",
  "organizationId": "client_2ofTA13AD0xBtbEvBl20aEb1hEu",
  "secret": "<string>"
}

Authorizations

​
X-API-Key
string
header
required

Includes an API key in the HTTP headers to authenticate the client.

​
X-API-Secret
string
header
required

Includes an API secret in the HTTP headers to authenticate the client.

Body

application/json
​
url
string<uri>
required
​
events
enum<string>[]
required
Minimum array length: 1
Available options:
counterparty.active,
counterparty.compliance_rejected,
counterparty.deleted,
counterparty.in_compliance_review,
customer.active,
customer.in_compliance_review,
customer.compliance_rejected,
customer.created,
customer.kyb_in_progress,
customer.kyb_expired,
customer.kyb_missing_information,
customer.account_onboarding_pending,
transaction.initializing,
transaction.created,
transaction.compliance_approved,
transaction.compliance_rejected,
transaction.completed,
transaction.awaiting_funds,
transaction.funds_received,
transaction.cancelled,
transaction.in_compliance_review,
transaction.awaiting_compliance_review,
transaction.processing_withdrawal,
transaction.withdrawal_processed,
transaction.processing_settlement,
transaction.settlement_processed,
transaction.processing_payment,
transaction.payment_processed
​
status
enum<string>
required
Available options:
enabled,
disabled
​
organizationId
string

A valid Client ID

Pattern: ^client_[a-zA-Z0-9]{27}$
Example:

"client_2ofTA13AD0xBtbEvBl20aEb1hEu"

Response

The created webhook

​
url
string<uri>
required
​
events
enum<string>[]
required
Minimum array length: 1
Available options:
counterparty.active,
counterparty.compliance_rejected,
counterparty.deleted,
counterparty.in_compliance_review,
customer.active,
customer.in_compliance_review,
customer.compliance_rejected,
customer.created,
customer.kyb_in_progress,
customer.kyb_expired,
customer.kyb_missing_information,
customer.account_onboarding_pending,
transaction.initializing,
transaction.created,
transaction.compliance_approved,
transaction.compliance_rejected,
transaction.completed,
transaction.awaiting_funds,
transaction.funds_received,
transaction.cancelled,
transaction.in_compliance_review,
transaction.awaiting_compliance_review,
transaction.processing_withdrawal,
transaction.withdrawal_processed,
transaction.processing_settlement,
transaction.settlement_processed,
transaction.processing_payment,
transaction.payment_processed
​
status
enum<string>
required
Available options:
enabled,
disabled
​
id
string
required

A valid Webhook ID

Pattern: ^whk_[a-zA-Z0-9]{27}$
Example:

"whk_2ofTA13AD0xBtbEvBl20aEb1hEu"

​
organizationId
string

A valid Client ID

Pattern: ^client_[a-zA-Z0-9]{27}$
Example:

"client_2ofTA13AD0xBtbEvBl20aEb1hEu"

​
secret
string