Do not miss any Integration Hub API changes, ever again

Subscribe to the Integration Hub API changelog to be up to date on recent changes.

RSS

Sep 8, 2026

main
3.0
Compare

API structure has changed

Next change
13 structure changes including:
1 Breaking change
4 Additions
8 Modifications
1 Removal
Modified 8 Breaking
GET /api/v3.0/{engagementSid}/files/{inboundFileCategory}/{uniqueFileName}/status
  • Response
  • 200 response Modified
    • application/json content type Modified
      • finishedTime property Modified
        • Property is now required
          Breaking
        • Type went from string(date-time) | null to null | string(date-time)
  • 400 response Modified
    • application/problem+json content type Modified
      • type, title, detail, instance properties Modified
        • Type went from string | null to string
          Breaking
      • status property Modified
        • Type went from integer(int32) | null to integer(int32)
          Breaking
  • 401 response Modified
    • application/problem+json content type Modified
      • type, title, detail, instance properties Modified
        • Type went from string | null to string
          Breaking
      • status property Modified
        • Type went from integer(int32) | null to integer(int32)
          Breaking
  • 403 response Modified
    • application/problem+json content type Modified
      • type, title, detail, instance properties Modified
        • Type went from string | null to string
          Breaking
      • status property Modified
        • Type went from integer(int32) | null to integer(int32)
          Breaking
  • 500 response Modified
    • application/problem+json content type Modified
      • type, title, detail, instance properties Modified
        • Type went from string | null to string
          Breaking
      • status property Modified
        • Type went from integer(int32) | null to integer(int32)
          Breaking
  • default response Modified
    • application/problem+json content type Modified
      • type, title, detail, instance properties Modified
        • Type went from string | null to string
          Breaking
      • status property Modified
        • Type went from integer(int32) | null to integer(int32)
          Breaking
  • Authentication
  • Adra personal access token & Adra oauth code pkce & Adra oauth client cred authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Adra personal access token, Adra oauth client cred authentication methods Added
GET /api/v3.0/{engagementSid}/files/{outboundFileCategory}/{uniqueFileName}
  • Response
  • 400 response Modified
    • application/problem+json content type Modified
      • type, title, detail, instance properties Modified
        • Type went from string | null to string
          Breaking
      • status property Modified
        • Type went from integer(int32) | null to integer(int32)
          Breaking
  • 401 response Modified
    • application/problem+json content type Modified
      • type, title, detail, instance properties Modified
        • Type went from string | null to string
          Breaking
      • status property Modified
        • Type went from integer(int32) | null to integer(int32)
          Breaking
  • 403 response Modified
    • application/problem+json content type Modified
      • type, title, detail, instance properties Modified
        • Type went from string | null to string
          Breaking
      • status property Modified
        • Type went from integer(int32) | null to integer(int32)
          Breaking
  • 404 response Modified
    • application/problem+json content type Modified
      • type, title, detail, instance properties Modified
        • Type went from string | null to string
          Breaking
      • status property Modified
        • Type went from integer(int32) | null to integer(int32)
          Breaking
  • 412 response Modified
    • application/problem+json content type Modified
      • type, title, detail, instance properties Modified
        • Type went from string | null to string
          Breaking
      • status property Modified
        • Type went from integer(int32) | null to integer(int32)
          Breaking
  • 500 response Modified
    • application/problem+json content type Modified
      • type, title, detail, instance properties Modified
        • Type went from string | null to string
          Breaking
      • status property Modified
        • Type went from integer(int32) | null to integer(int32)
          Breaking
  • default response Modified
    • application/problem+json content type Modified
      • type, title, detail, instance properties Modified
        • Type went from string | null to string
          Breaking
      • status property Modified
        • Type went from integer(int32) | null to integer(int32)
          Breaking
  • Authentication
  • Adra personal access token & Adra oauth code pkce & Adra oauth client cred authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Adra personal access token, Adra oauth code pkce, Adra oauth client cred authentication methods Added
POST /api/v3.0/{engagementSid}/files/{inboundFileCategory}/{suggestedFileName}
  • Response
  • 400 response Modified
    • application/problem+json content type Modified
      • type, title, detail, instance properties Modified
        • Type went from string | null to string
          Breaking
      • status property Modified
        • Type went from integer(int32) | null to integer(int32)
          Breaking
  • 401 response Modified
    • application/problem+json content type Modified
      • type, title, detail, instance properties Modified
        • Type went from string | null to string
          Breaking
      • status property Modified
        • Type went from integer(int32) | null to integer(int32)
          Breaking
  • 403 response Modified
    • application/problem+json content type Modified
      • type, title, detail, instance properties Modified
        • Type went from string | null to string
          Breaking
      • status property Modified
        • Type went from integer(int32) | null to integer(int32)
          Breaking
  • 411 response Modified
    • application/problem+json content type Modified
      • type, title, detail, instance properties Modified
        • Type went from string | null to string
          Breaking
      • status property Modified
        • Type went from integer(int32) | null to integer(int32)
          Breaking
  • 413 response Modified
    • application/problem+json content type Modified
      • type, title, detail, instance properties Modified
        • Type went from string | null to string
          Breaking
      • status property Modified
        • Type went from integer(int32) | null to integer(int32)
          Breaking
  • 500 response Modified
    • application/problem+json content type Modified
      • type, title, detail, instance properties Modified
        • Type went from string | null to string
          Breaking
      • status property Modified
        • Type went from integer(int32) | null to integer(int32)
          Breaking
  • default response Modified
    • application/problem+json content type Modified
      • type, title, detail, instance properties Modified
        • Type went from string | null to string
          Breaking
      • status property Modified
        • Type went from integer(int32) | null to integer(int32)
          Breaking
  • Authentication
  • Adra personal access token & Adra oauth code pkce & Adra oauth client cred authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Adra personal access token, Adra oauth client cred authentication methods Added
POST BalancerBalanceJobCompletedEventwebhook
  • Body
  • application/json content type Modified
    • EventId, CorrelationId, EventType, EventMessage, CreatedDate, Payload properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • Engagement, UniqueFileName, Result properties Added
  • Response
  • default response Modified
    • application/problem+json content type Modified
      • type, title, detail, instance properties Modified
        • Type went from string | null to string
          Breaking
      • status property Modified
        • Type went from integer(int32) | null to integer(int32)
          Breaking
POST BalancerTransactionJobCompletedEventwebhook
  • Body
  • application/json content type Modified
    • EventId, CorrelationId, EventType, EventMessage, CreatedDate, Payload properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • Engagement, UniqueFileName, Result properties Added
  • Response
  • default response Modified
    • application/problem+json content type Modified
      • type, title, detail, instance properties Modified
        • Type went from string | null to string
          Breaking
      • status property Modified
        • Type went from integer(int32) | null to integer(int32)
          Breaking
POST LegalEntityJobCompletedEventwebhook
  • Body
  • application/json content type Modified
    • EventId, CorrelationId, EventType, EventMessage, CreatedDate, Payload properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • Engagement, UniqueFileName, Result properties Added
  • Response
  • default response Modified
    • application/problem+json content type Modified
      • type, title, detail, instance properties Modified
        • Type went from string | null to string
          Breaking
      • status property Modified
        • Type went from integer(int32) | null to integer(int32)
          Breaking
POST MatcherReportPublishedEventwebhook
  • Body
  • application/json content type Modified
    • EventId, CorrelationId, EventType, EventMessage, CreatedDate, Payload properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • UniqueFileName, DownloadUrl properties Added
  • Response
  • default response Modified
    • application/problem+json content type Modified
      • type, title, detail, instance properties Modified
        • Type went from string | null to string
          Breaking
      • status property Modified
        • Type went from integer(int32) | null to integer(int32)
          Breaking
POST MatcherTransactionJobCompletedEventwebhook
  • Body
  • application/json content type Modified
    • EventId, CorrelationId, EventType, EventMessage, CreatedDate, Payload properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • Engagement, UniqueFileName, Result properties Added
  • Response
  • default response Modified
    • application/problem+json content type Modified
      • type, title, detail, instance properties Modified
        • Type went from string | null to string
          Breaking
      • status property Modified
        • Type went from integer(int32) | null to integer(int32)
          Breaking
Removed 1 Breaking
Adra personal access token & Adra oauth code pkce & Adra oauth client credauthentication method
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 4
Adra oauth client credauthentication method
Adra oauth code pkceauthentication method
Adra personal access tokenauthentication method
POST ClosingRateJobCompletedEventwebhook