CRS logo

Test API

REST APIs for Testing webhooks

Collection of end-points for testing webhooks

Endpoints

  1. New Pre-auth Token

    2. /test/preauth-token/{userId}


  2. Webhook Test

    3. /test/webhook/send/{userId}


  3. Webhook Sink

    4. /test/webhook/sink


preauthToken

Request
path Parameters
id
required
string <uuid>
Responses
200

OK

400

Bad Request

401

Unauthorized

409

Conflict

500

Internal Server Error

503

Service Unavailable

get/test/preauth-token/{id}
Request samples 
webhookSink
Request 
query Parameters
fail
boolean
 Default:  false
 
Request Body schema: application/json
required
 Array 
id
string <uuid> 
 
type
string
 Enum: "ACCNEW" "IDFAIL" "IDSVCOUT" "ACCREG" "ACCREGFAIL" "ACCCLOSED" "ACCLOCKED" "ACCLOGINFAIL" "ACCALERT" "SCOREREF" "REPORTREF" "TEST" "ERROR"  
user_id
string <uuid> 
 
host_id
string <uuid> 
 
alert_id
string <uuid> 
 
alert_date
string <date-time> 
 
alert_source
string
 
time
string <date-time> 
 
error_code
string
 
error_msg
string
 
Responses 
200
OK


400
Bad Request


401
Unauthorized


409
Conflict


500
Internal Server Error


503
Service Unavailable


post/test/webhook/sink
Request samples 
application/json
[
  • {
    }
]
webhookTest
Request 
path Parameters
id
required
string <uuid> 
 
query Parameters
type
string
 Enum: "ACCNEW" "IDFAIL" "IDSVCOUT" "ACCREG" "ACCREGFAIL" "ACCCLOSED" "ACCLOCKED" "ACCLOGINFAIL" "ACCALERT" "SCOREREF" "REPORTREF" "TEST" "ERROR"  
error
string
 Default:  ""
 
count
integer <int32> 
 Default:  1
 
Request Body schema: application/json
enrollmentId
string
 
alertId
string
 
alertType
string
 
creationDate
string <date-time> 
 
dataSource
string
 
dateReported
string <date-time> 
 
reportingFrequency
string
 
tenantKey
string
 
institutionType
string
 
institutionName
string
 
memberNumber
string
 
inquiryIntent
string
 
inquiryType
string
 
endUserText
string
 
institutionAddressLine1
string
 
institutionAddressLine2
string
 
institutionCity
string
 
institutionState
string
 
institutionPostalCode
string
 
institutionPhoneNumber
string
 
customerReferenceNumber
string
 
postedDuringMaintenancePeriod
boolean
 
Responses 
200
OK


400
Bad Request


401
Unauthorized


409
Conflict


500
Internal Server Error


503
Service Unavailable


post/test/webhook/send/{id}
Request samples 
application/json
{
  • "enrollmentId": "string",
  • "alertId": "string",
  • "alertType": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "dataSource": "string",
  • "dateReported": "2019-08-24T14:15:22Z",
  • "reportingFrequency": "string",
  • "tenantKey": "string",
  • "institutionType": "string",
  • "institutionName": "string",
  • "memberNumber": "string",
  • "inquiryIntent": "string",
  • "inquiryType": "string",
  • "endUserText": "string",
  • "institutionAddressLine1": "string",
  • "institutionAddressLine2": "string",
  • "institutionCity": "string",
  • "institutionState": "string",
  • "institutionPostalCode": "string",
  • "institutionPhoneNumber": "string",
  • "customerReferenceNumber": "string",
  • "postedDuringMaintenancePeriod": true
}
➔ Next to Sandbox