Create Webhook

Create URL endpoint for Webhook

  • event types:
  • all, card.created, card.activated, card.status, card.pin.changed, card.replaced, card.fulfilment,
  • person.created, person.verification.success, person.updated,
  • wallet.created, account.created, account.activated, account.closed, account.status, account.instrument.created,
  • outside.instrument.created, outside.instrument.updated,
  • auth.approved, auth.reversed, auth.refunded,auth.declined,
  • bankeft.credit.received, bankeft.credit.reversed, bankeft.credit.returned,
  • bankeft.debit.received, bankeft.debit.reversed, bankeft.debit.returned,
  • transfer.success, check.cleared, payment.success, payment.failure, realtimepayment,
  • company.created, company.updated
  • Request
    Security:
    path Parameters
    version
    required
    string
    Request Body schema: application/json
    notification_guid
    string <uuid>

    unique notification subscription guid

    program_guid
    required
    string <uuid>

    qolo program guid

    url
    required
    string non-empty

    client endpoint url to send webhook

    headers
    string or null

    additional HTTP headers to send with webhook

    secret
    string or null

    secret will be used to send checksum value of payload for message authentication

    active
    boolean or null

    turn on / off webhook subscription service

    event_type
    required
    Array of strings

    event types "all" "card.created" "card.activated" "card.status" "card.pin.changed" "card.replaced" "card.fulfilment" "person.created" "person.verification.success" "person.updated" "wallet.created" "account.created" "account.activated" "account.closed" "account.status" "account.instrument.created" "outside.instrument.created" "outside.instrument.updated" "auth.approved" "auth.reversed" "auth.refunded" "bankeft.credit.received" "bankeft.credit.reversed" "bankeft.credit.returned" "bankeft.debit.received" "bankeft.debit.reversed" "bankeft.debit.returned" "transfer.success" "check.cleared" "payment.success" "payment.failure" "company.created" "company.updated"

    Responses
    201

    Returns newly created Webhook details

    400

    Bad request

    401

    Unauthorized

    404

    Webhook not found

    500

    Server Error

    post/api/{version}/webhooks
    Request samples
    application/json
    {
    • "notification_guid": "9c1d96b3-0c4d-4b89-9eb0-68c18dac59b2",
    • "program_guid": "3fa0d2ea-ffcf-485d-94ed-dbf4f861ad2f",
    • "url": "string",
    • "headers": "string",
    • "secret": "string",
    • "active": true,
    • "event_type": [
      • "string"
      ]
    }
    Response samples
    application/json
    {
    • "notification_guid": "9c1d96b3-0c4d-4b89-9eb0-68c18dac59b2",
    • "program_guid": "3fa0d2ea-ffcf-485d-94ed-dbf4f861ad2f",
    • "url": "string",
    • "headers": "string",
    • "secret": "string",
    • "active": true,
    • "event_type": [
      • "string"
      ]
    }
    Copyright © 2023 KeyBank & Qolo. All rights reserved.