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

Changelog

Last update:
Compare
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
4 structure changes including:
2 Additions
2 Modifications
Modified 2 Breaking
GET /api/v3.0/{engagementSid}/files/{inboundFileCategory}/{uniqueFileName}/status
  • Path
  • inboundFileCategory path parameter Modified
    • Path parameter is now required
      Breaking
POST /api/v3.0/{engagementSid}/files/{inboundFileCategory}/{suggestedFileName}
  • Header
  • X-State header Added
Added 2
POST BalancerBalanceJobCompletedEventwebhook
POST BalancerTransactionJobCompletedEventwebhook
2 structure changes including:
2 Modifications
Modified 2 Breaking
POST LegalEntityJobCompletedEventwebhook
  • Body
  • application/json content type Modified
    • Payload property Modified
      • Result property Modified
        • Type went from object to string
          Breaking
        • PartiallySucceeded, Succeeded, Failed, Rejected, WaitingInteraction, Discarded, Deleted properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
POST MatcherTransactionJobCompletedEventwebhook
  • Body
  • application/json content type Modified
    • Payload property Modified
      • Result property Modified
        • Type went from object to string
          Breaking
        • PartiallySucceeded, Succeeded, Failed, Rejected, WaitingInteraction, Discarded, Deleted properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
1 structure change including:
1 Addition
Added 1
POST LegalEntityJobCompletedEventwebhook
5 structure changes including:
2 Additions
3 Modifications
Modified 3 Breaking
GET /api/v3.0/{engagementSid}/files/{inboundFileCategory}/{uniqueFileName}/status
  • Response
  • 200 response Modified
    • application/json content type Modified
      • uniqueFileName property Modified
        • Property is now required
          Breaking
        • Type went from string | null to string
          Breaking
      • status, submittedTime properties Modified
        • Properties are now required
          Breaking
  • 400 response Modified
    • application/json content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • application/problem+json content type Added
  • default response Added
  • Authentication
  • Adra personal access token & Adra client credentials 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 method Added
  • Header
  • x-gw-stloc-hint header Added
GET /api/v3.0/{engagementSid}/files/{outboundFileCategory}/{uniqueFileName}
  • Response
  • 400 response Modified
    • application/json content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • application/problem+json content type Added
  • default response Added
  • Authentication
  • Adra personal access token & Adra client credentials 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 method Added
  • Header
  • x-gw-stloc-hint header Added
POST /api/v3.0/{engagementSid}/files/{inboundFileCategory}/{suggestedFileName}
  • Response
  • 201 response Modified
    • application/json content type Modified
      • uniqueFileName property Modified
        • Property is now required
          Breaking
        • Type went from string | null to string
          Breaking
  • 400 response Modified
    • application/json content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • application/problem+json content type Added
  • default response Added
  • Authentication
  • Adra personal access token & Adra client credentials 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 method Added
  • Header
  • x-gw-stloc-hint header Added
Added 2
POST MatcherReportPublishedEventwebhook
POST MatcherTransactionJobCompletedEventwebhook
3 structure changes including:
3 Modifications
Modified 3
GET /api/v3.0/{engagementSid}/files/{inboundFileCategory}/{uniqueFileName}/status
  • Authentication
  • Adra personal access token & Adra client credentials authentication method Modified
    • Adra client credentials authentication method Modified
GET /api/v3.0/{engagementSid}/files/{outboundFileCategory}/{uniqueFileName}
  • Authentication
  • Adra personal access token & Adra client credentials authentication method Modified
    • Adra client credentials authentication method Modified
POST /api/v3.0/{engagementSid}/files/{inboundFileCategory}/{suggestedFileName}
  • Authentication
  • Adra personal access token & Adra client credentials authentication method Modified
    • Adra client credentials authentication method Modified
3 structure changes including:
3 Modifications
Modified 3 Breaking
GET /api/v3.0/{engagementSid}/files/{inboundFileCategory}/{uniqueFileName}/status
  • Authentication
  • Adra personal access token & client_credentials authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Adra personal access token & Adra Client Credentials authentication method Added
GET /api/v3.0/{engagementSid}/files/{outboundFileCategory}/{uniqueFileName}
  • Authentication
  • Adra personal access token & client_credentials authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Adra personal access token & Adra Client Credentials authentication method Added
POST /api/v3.0/{engagementSid}/files/{inboundFileCategory}/{suggestedFileName}
  • Authentication
  • Adra personal access token & client_credentials authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Adra personal access token & Adra Client Credentials authentication method Added
3 structure changes including:
3 Modifications
Modified 3
GET /api/v3.0/{engagementSid}/files/{inboundFileCategory}/{uniqueFileName}/status
  • Authentication
  • Adra personal access token & client_credentials authentication method Added
GET /api/v3.0/{engagementSid}/files/{outboundFileCategory}/{uniqueFileName}
  • Authentication
  • Adra personal access token & client_credentials authentication method Added
POST /api/v3.0/{engagementSid}/files/{inboundFileCategory}/{suggestedFileName}
  • Authentication
  • Adra personal access token & client_credentials authentication method Added