View registered webhook events

GET /Webhooks/GetRegistrations

Use this call to view the webhook events you are registered to. These are the webhooks available:

  • AdjustmentActionUpdate
  • FundingAttemptComplete
  • LoanStatusUpdated
  • RailUpdated
  • ComplianceLoanFailed

For information, see: View webhook events available.

For information on registering webhooks, click Register a webhook.

Request URL

https:// ... /Webhooks/GetRegistrations

Sample request in cURL - GET /Webhooks/GetRegistrations

curl --location --request GET 'https://arixapisandbox.crbnj.net/Webhooks/GetRegistrations' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer ew0KICAiYWxnIjogIlJTMjU2IiwNCiAgImtpZCI6ICJ6WDU3TXE2NXRxNTJEQ0YwRGpQMVdObE9BTlUiLA0KICAidHlwIjogIkpXVCIsDQogICJ4NXQiOiAielg1N01xNjV0cTUyRENGMERqUDFXTmxPQU5VIg0KfQ.ew0KICAibmJmIjogMTYwMjY4OTE2MywNCiAgImV4cCI6IDE2MDI2OTI3NjMsDQogICJpc3MiOiAiaHR0cHM6Ly9vYXV0aHRlc3QuY3JibmoubmV0IiwNCiAgImF1ZCI6IFsNCiAgICAiaHR0cHM6Ly9vYXV0aHRlc3QuY3JibmoubmV0L3Jlc291cmNlcyIsDQogICAgImNyYmFwaSINCiAgXSwNCiAgImNsaWVudF9pZCI6ICJBcml4VGVzdFVzZXIiLA0KICAicm9sZSI6IFsNCiAgICAiQXV0aGVudGljYXRlZCBVc2VycyIsDQogICAgIlRoaXMgT3JnYW5pemF0aW9uIiwNCiAgICAiRGVueUFjY2VzcyIsDQogICAgIkFyaXhNUExVc2VyR3JvdXAiLA0KICAgICJTZXJ2aWNlIGFzc2VydGVkIGlkZW50aXR5IiwNCiAgICAiTWVkaXVtIE1hbmRhdG9yeSBMZXZlbCINCiAgXSwNCiAgInNjb3BlIjogWw0KICAgICJjcmJhcGkiDQogIF0NCn0.bbWwLZL1RuZuwsVf1BExRbsvjhfBhDphIzekPuUCSpLxrN3WHs0ekIbuNqljSbaxfEPvlT-3kWuXIM2jYFXGCU0wMubWogqvNfQVP7fUO7NUJWbOIxXKamKg5ZuLhL0SfYdq5uWfnQ63vTmbDRPX3SFMA2ngC1uxkxEVJiZbDGr7hYtd0Vra6h-bpftJgsTKLRBMT2hV6JpwbFQ5IE40722kIw1lAQ1shcFkPfBqi0WEASyHoit2TfrWA958I_PS8VkKTZqK-utgQHIX8E92I_ZmQHzzYzdn5Wz_jPI2cqXaMgvz_c3Wq16odWKo0zwr6w814MZlOV-1wLcSLqyxJw' \
--header 'Cookie: ss-opt=temp; ss-id=4R8GJ0cnbN4jS0dU4Dq6; ss-pid=FF4O2hH7WqvHxDCqm8Bd'

Sample response in JSON - GET /Webhooks/GetRegistrations

In the response below, these events are registered:

  • ComplianceLoanFailed
  • LoanStatusUpdated
  • FundingAttemptComplete

Note that each of the EventNames have an Id number. That is the ID number you will need if you want to unregister a webhook event.

[
    {
        "Id": 661,
        "MPLId": "TST",
        "EventName": "ComplianceLoanFailed"
    },
    {
        "Id": 666,
        "MPLId": "TST",
        "EventName": "LoanStatusUpdated",
        "CallbackURL": "https://webhook.site/2acbdfa8-8912-48bb-a58a-9100e1418441\n"
    },
    {
        "Id": 667,
        "MPLId": "TST",
        "EventName": "FundingAttemptComplete",
        "CallbackURL": "https://webhook.site/2acbdfa8-8912-48bb-a58a-9100e1418441\n"
    }
]

Attribute

Description

Id

ID of the event name.

MPLId

ID of the MPL.

EventName

Name of the event that is being reported.

CallbackURL

The destination endpoint that receives the webhook report.

Unregistering webhook events

You can unregister webhook events. For more information, see Unregister a webhook event.


Did this page help you?