{"items":[{"type":"link","label":"Event OpenAPI Specification","link":"/process-intelligence-apis/subscription-api/outbound-api-reference/openapi/outbound-openapi","routeSlug":"/process-intelligence-apis/subscription-api/outbound-api-reference/openapi/outbound-openapi","content":{"contentType":"overview","meta":{"name":"Event OpenAPI Specification"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"outbound-openapi.json","url":"/_bundle/process-intelligence-apis/subscription-api/outbound-api-reference/openapi/outbound-openapi.json?download"},{"kind":"download","label":"outbound-openapi.yaml","url":"/_bundle/process-intelligence-apis/subscription-api/outbound-api-reference/openapi/outbound-openapi.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"js","title":"JS","lang":"JavaScript"},{"key":"curl","title":"curl","lang":"curl"},{"key":"java","title":"Java","lang":"Java"},{"key":"python","title":"Python","lang":"Python"},{"key":"php","title":"PHP","lang":"PHP"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"/_mock/process-intelligence-apis/subscription-api/outbound-api-reference/openapi/outbound-openapi","description":"Test Server","isMockServer":true}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Event OpenAPI Specification (1.0.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":"Subscription API to send events to a webhook configured when creating a subscription. Our API can send automatically events to a deffined webhook."}],"sectionId":"/process-intelligence-apis/subscription-api/outbound-api-reference/openapi/outbound-openapi"}],"sectionId":"/process-intelligence-apis/subscription-api/outbound-api-reference/openapi/outbound-openapi"}]}]}},{"type":"group","label":"Webhook","link":"/process-intelligence-apis/subscription-api/outbound-api-reference/openapi/outbound-openapi/webhook","routeSlug":"/process-intelligence-apis/subscription-api/outbound-api-reference/openapi/outbound-openapi/webhook","items":[{"label":"Receive asynchronous events from Subscription API","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/process-intelligence-apis/subscription-api/outbound-api-reference/openapi/outbound-openapi/webhook/consumevents","routeSlug":"/process-intelligence-apis/subscription-api/outbound-api-reference/openapi/outbound-openapi/webhook/consumevents","metadata":{"seo":{"title":"Receive asynchronous events from Subscription API","description":"Receive asynchronous events"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"consumEvents","name":"Receive asynchronous events from Subscription API","isWebhook":false,"pointer":"/paths/~1api~1events/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Receive asynchronous events from Subscription API","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Receive asynchronous events"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]},{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"AppKey"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/eventDTO"}},"schemaId":"components/schemas/eventDTO","pointer":"/paths/~1api~1events/post/requestBody","description":"Event from a Record or Data Model"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/events","servers":[{"url":"/_mock/process-intelligence-apis/subscription-api/outbound-api-reference/openapi/outbound-openapi","description":"Test Server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"AppKey","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/eventDTO"}},"responseCodes":["400","401","403","429","500","503","2XX"],"pointer":"/api/events","href":"webhook/consumevents","openApiOperationId":"consumEvents","summary":"Receive asynchronous events from Subscription API","securityGroups":[{"BearerAuth":[]},{"ApiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/process-intelligence-apis/subscription-api/outbound-api-reference/openapi/outbound-openapi","description":"Test Server","isMockServer":true}],"schemaId":"components/schemas/eventDTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/eventDTO"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"400","description":"Bad Request.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/errorDTO"}},"schemaId":"components/schemas/errorDTO"},{"code":"401","description":"Unauthorized access.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/authErrorDTO"}},"schemaId":"components/schemas/authErrorDTO"},{"code":"403","description":"Forbidden.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/errorDTO"}},"schemaId":"components/schemas/errorDTO"},{"code":"429","description":"Too Many Requests.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/errorDTO"}},"schemaId":"components/schemas/errorDTO"},{"code":"500","description":"Internal Server Error.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/errorDTO"}},"schemaId":"components/schemas/errorDTO"},{"code":"503","description":"Service Unavailable.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/errorDTO"}},"schemaId":"components/schemas/errorDTO"},{"code":"2XX","description":"Event received"}],"pointer":"/paths/~1api~1events/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"400","schemaId":"components/schemas/errorDTO","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/errorDTO"}}},{"code":"401","schemaId":"components/schemas/authErrorDTO","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/authErrorDTO"}}},{"code":"403","schemaId":"components/schemas/errorDTO","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/errorDTO"}}},{"code":"429","schemaId":"components/schemas/errorDTO","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/errorDTO"}}},{"code":"500","schemaId":"components/schemas/errorDTO","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/errorDTO"}}},{"code":"503","schemaId":"components/schemas/errorDTO","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/errorDTO"}}},{"code":"2XX"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhook/consumevents"}],"panels":[]}]},"httpPath":"/api/events"}],"content":{"contentType":"group","meta":{"name":"Webhook"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Webhook","showPageActions":true},{"nodeType":"markdoc","content":"Webhook used to receive asynchronous events from Subscription API"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/events","summary":"Receive asynchronous events from Subscription API","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhook/consumevents","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/errorDTO":{"id":"components/schemas/errorDTO","kind":"json-schema","title":"Error","data":{"title":"Error","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This [RFC7807] specification is to define common error formats for those applications that need one, so that they aren't required to define their own, or worse, tempted to redefine the semantics of existing HTTP status codes. This definition was copied from https://datatracker.ietf.org/doc/html/rfc7807"},"children":[]}]}]}],"properties":{"title":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A short, human-readable summary of the problem type.  It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4). This definition was copied from https://datatracker.ietf.org/doc/html/rfc7807"},"children":[]}]}]}]},"status":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem. This definition was copied from https://datatracker.ietf.org/doc/html/rfc7807"},"children":[]}]}]}]},"detail":{"type":"string","description":"The details of the Error"},"errorCode":{"type":"string","description":"Unique Identifier of the Error"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A URI reference [RFC3986] that identifies the problem type. This definition was copied from https://datatracker.ietf.org/doc/html/rfc7807"},"children":[]}]}]}]}}}},"components/schemas/eventDTO":{"id":"components/schemas/eventDTO","kind":"json-schema","title":"Asynchronous event","data":{"title":"Asynchronous event","description":"Asynchronous event triggered by Subscription","type":"object","properties":{"subscriberId":{"type":"string","description":"Subscriber's Unique identifier as a SUID","example":"abc-123-bad-123"},"triggerId":{"type":"string","description":"Trigger's Unique identifier as a SUID","example":"abc-123-bad-123"},"offset":{"type":"number","description":"Position of the event in the subscription Queue source","example":1234},"creationDate":{"type":"string","format":"date-time","description":"Date of the event creation","example":"2023-07-21T17:32:28Z"},"event":{"$ref":"#/components/schemas/signalEventDTO"}}}},"components/schemas/signalEventDTO":{"id":"components/schemas/signalEventDTO","kind":"json-schema","title":"signalEventDTO","data":{"type":"object","properties":{"id":{"type":"string","description":"Event's Unique identifier as a SUID","example":"abc-123-bad-123"},"identifier":{"type":"string","description":"Third party Identifier as a string","example":1},"typedIdentifier":{"type":"object","description":"Type of the Identifier for the event","example":2},"fields":{"type":"array","description":"Fields for the Event","items":{"$ref":"#/components/schemas/eventFieldDTO"}}}}},"components/schemas/eventFieldDTO":{"id":"components/schemas/eventFieldDTO","kind":"json-schema","title":"Fields Metadata for the event","data":{"title":"Fields Metadata for the event","description":"Fields Metadata for the event","type":"object","properties":{"id":{"type":"string","description":"Id for the field as a String","example":"CASE_NUMBER"},"value":{"type":"object","description":"Value for the field, it could be any type of (date, string, float, int)","example":"my_value"},"type":{"type":"string","description":"The type that applies to the value (DATE, STRING, FLOAT, INT)","example":"STRING"},"isIdentifier":{"type":"boolean","description":"If the field is used as an identifier","example":true}}}},"components/schemas/authErrorDTO":{"id":"components/schemas/authErrorDTO","kind":"json-schema","title":"Authentication Error","data":{"title":"Authentication Error","type":"object","properties":{"error":{"type":"string"}}}}},"exampleStore":{},"securitySchemeStore":{"BearerAuth":{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"},"ApiKeyAuth":{"id":"ApiKeyAuth","type":"apiKey","in":"header","paramName":"AppKey"}},"servers":[{"url":"/_mock/process-intelligence-apis/subscription-api/outbound-api-reference/openapi/outbound-openapi","isMockServer":true,"description":"Test Server"}]},"options":{"jsonSamplesExpandLevel":"all","schemasExpansionLevel":2,"codeSamples":{"languages":[{"lang":"JavaScript","label":"JS"},{"lang":"curl","label":"curl"},{"lang":"Java","label":"Java"},{"lang":"Python","label":"Python"},{"lang":"PHP","label":"PHP"}],"skipOptionalParameters":false},"hideDownloadButtons":false,"hideSchemaTitles":false,"feedback":{"type":"comment","settings":{"label":"Share your feedback for this page.","submitText":"Your comment has been sent to our team!"}},"hideSidebar":true,"mockServer":{"url":"/_mock/process-intelligence-apis/subscription-api/outbound-api-reference/openapi/outbound-openapi","position":"replace","description":"Test Server","off":false,"strictExamples":false,"errorIfForcedExampleNotFound":false},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/process-intelligence-apis/subscription-api/outbound-api-reference/openapi/outbound-openapi.json?download"},{"url":"/_bundle/process-intelligence-apis/subscription-api/outbound-api-reference/openapi/outbound-openapi.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Event OpenAPI Specification","description":"Subscription API to send events to a webhook configured when creating a subscription. Our API can send automatically events to a deffined webhook."}},"baseSlug":"/process-intelligence-apis/subscription-api/outbound-api-reference/openapi/outbound-openapi","routesMapping":{}}