Webhook

Subscribe to a webhook

Create new webhook subscription. The webhooks not subscribed yet can all be subscribed at once with the same url using the 'DEFAULT' type.

Note: If you subscribe to a webhook you were already subscribed, the new subscription will override the last one.

SecurityLinkcy-Auth
Request
path Parameters
webhookType
required
string
Enum: "DEFAULT" "CONSUMER_LOGGED_IN" "CORPORATE_LOGGED_IN" "CONSUMER_CREATED" "CORPORATE_CREATED" "CORPORATE_RELATED_PHYSICAL_PERSON_CREATED" "CORPORATE_RELATED_CORPORATE_CREATED" "CONSUMER_KYC_VALIDATED" "CORPORATE_KYB_VALIDATED" "CONSUMER_KYC_CREATED" "CORPORATE_RELATED_KYC_CREATED" "CONSUMER_KYC_UPDATED" "CONSUMER_UPDATED" "CORPORATE_RELATED_KYC_UPDATED" "CORPORATE_UPDATED" "CORPORATE_KYB_UPDATED" "LEDGER_CREATED" "LEDGER_UPGRADED" "LEDGER_UPDATED" "LEDGER_BALANCE_UPDATED" "BENEFICIARY_CREATED" "BENEFICIARY_UPDATED" "CARD_CREATED" "CARD_UPDATED" "CARD_RENEWED" "CARD_CLOSED" "TRANSACTION_CREATED" "TRANSACTION_UPDATED"
Request Body schema: application/json
url
required
string [ 0 .. 511 ] characters

Url on which the webhook will be sent.

Responses
204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

409

Conflict

500

Internal Server Error

put/api/partner/webhooks/{webhookType}
Request samples
application/json
{
  • "url": "string"
}
Response samples
application/json
{
  • "status": 400,
  • "details": [
    ],
  • "error": "linkcy.bad.request",
  • "timestamp": "2019-08-24T14:15:22Z"
}

Unsubscribe from a webhook

Delete a webhook subscription. If you unsubscribe from 'DEFAULT', all webhooks that you have not individually subscribed to will be deactivated.

SecurityLinkcy-Auth
Request
path Parameters
webhookType
required
string
Enum: "DEFAULT" "CONSUMER_LOGGED_IN" "CORPORATE_LOGGED_IN" "CONSUMER_CREATED" "CORPORATE_CREATED" "CORPORATE_RELATED_PHYSICAL_PERSON_CREATED" "CORPORATE_RELATED_CORPORATE_CREATED" "CONSUMER_KYC_VALIDATED" "CORPORATE_KYB_VALIDATED" "CONSUMER_KYC_CREATED" "CORPORATE_RELATED_KYC_CREATED" "CONSUMER_KYC_UPDATED" "CONSUMER_UPDATED" "CORPORATE_RELATED_KYC_UPDATED" "CORPORATE_UPDATED" "CORPORATE_KYB_UPDATED" "LEDGER_CREATED" "LEDGER_UPGRADED" "LEDGER_UPDATED" "LEDGER_BALANCE_UPDATED" "BENEFICIARY_CREATED" "BENEFICIARY_UPDATED" "CARD_CREATED" "CARD_UPDATED" "CARD_RENEWED" "CARD_CLOSED" "TRANSACTION_CREATED" "TRANSACTION_UPDATED"
Responses
204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

409

Conflict

500

Internal Server Error

delete/api/partner/webhooks/{webhookType}
Request samples
Response samples
application/json
{
  • "status": 400,
  • "details": [
    ],
  • "error": "linkcy.bad.request",
  • "timestamp": "2019-08-24T14:15:22Z"
}

List your webhook subscriptions

Get all your webhook subscriptions.

SecurityLinkcy-Auth
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

409

Conflict

500

Internal Server Error

get/api/partner/webhooks
Request samples
Response samples
application/json
{
  • "webhookSubscriptions": [
    ]
}