{"items":[{"type":"link","label":"Webhooks Connect API","link":"/apis/webhooks","routeSlug":"/apis/webhooks","content":{"contentType":"overview","meta":{"name":"Webhooks Connect API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"webhooks.json","url":"/_bundle/apis/webhooks.json?download"},{"kind":"download","label":"webhooks.yaml","url":"/_bundle/apis/webhooks.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"cURL","lang":"curl"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://connect.wallapop.com","description":"Production"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Webhooks Connect API (0.0.1)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":"API for managing webhooks to subscribe to specific events related to items in Wallapop."}],"sectionId":"/apis/webhooks"}],"sectionId":"/apis/webhooks"}]}]}},{"type":"group","label":"Webhooks","link":"/apis/webhooks/webhooks","routeSlug":"/apis/webhooks/webhooks","items":[{"label":"Create a new webhook","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/webhooks/webhooks/createwebhook","routeSlug":"/apis/webhooks/webhooks/createwebhook","metadata":{"seo":{"title":"Create a new webhook","description":"Register a new webhook for the authenticated user, allowing you to receive event notifications."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createWebhook","name":"Create a new webhook","isWebhook":false,"pointer":"/paths/~1webhooks/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a new webhook","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Register a new webhook for the authenticated user, allowing you to receive event notifications."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuthWithPKCE","scopes":[],"type":"oauth2","description":"The Webhooks Connect API utilizes the OAuth 2.0 Authorization Code flow with Proof Key for Code Exchange (PKCE) for secure authentication and token exchange.","flows":{"authorizationCode":{"authorizationUrl":"https://iam.wallapop.com/realms/wallapop-connect/protocol/openid-connect/auth","tokenUrl":"https://iam.wallapop.com/realms/wallapop-connect/protocol/openid-connect/token","refreshUrl":"https://iam.wallapop.com/realms/wallapop-connect/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WebhookRequest"}},"schemaId":"components/schemas/WebhookRequest","pointer":"/paths/~1webhooks/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/webhooks","servers":[{"url":"https://connect.wallapop.com","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuthWithPKCE","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://iam.wallapop.com/realms/wallapop-connect/protocol/openid-connect/auth","tokenUrl":"https://iam.wallapop.com/realms/wallapop-connect/protocol/openid-connect/token","refreshUrl":"https://iam.wallapop.com/realms/wallapop-connect/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/WebhookRequest"}},"responseCodes":["200","400"],"pointer":"/webhooks","href":"webhooks/createwebhook","openApiOperationId":"createWebhook","summary":"Create a new webhook"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://connect.wallapop.com","description":"Production"}],"schemaId":"components/schemas/WebhookRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WebhookRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The webhook was created successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateWebhookResponse"}},"schemaId":"components/schemas/CreateWebhookResponse"},{"code":"400","description":"Bad request. The server cannot process the request due to client-side issues, such as malformed syntax or invalid parameters.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1webhooks/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreateWebhookResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateWebhookResponse"}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/createwebhook"}],"panels":[]}]},"httpPath":"/webhooks"},{"label":"Retrieve webhooks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/webhooks/webhooks/findmywebhooks","routeSlug":"/apis/webhooks/webhooks/findmywebhooks","metadata":{"seo":{"title":"Retrieve webhooks","description":"Retrieves a list of your webhooks."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"findMyWebhooks","name":"Retrieve webhooks","isWebhook":false,"pointer":"/paths/~1webhooks/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve webhooks","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of your webhooks."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuthWithPKCE","scopes":[],"type":"oauth2","description":"The Webhooks Connect API utilizes the OAuth 2.0 Authorization Code flow with Proof Key for Code Exchange (PKCE) for secure authentication and token exchange.","flows":{"authorizationCode":{"authorizationUrl":"https://iam.wallapop.com/realms/wallapop-connect/protocol/openid-connect/auth","tokenUrl":"https://iam.wallapop.com/realms/wallapop-connect/protocol/openid-connect/token","refreshUrl":"https://iam.wallapop.com/realms/wallapop-connect/protocol/openid-connect/token","scopes":{}}}}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/webhooks","servers":[{"url":"https://connect.wallapop.com","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuthWithPKCE","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://iam.wallapop.com/realms/wallapop-connect/protocol/openid-connect/auth","tokenUrl":"https://iam.wallapop.com/realms/wallapop-connect/protocol/openid-connect/token","refreshUrl":"https://iam.wallapop.com/realms/wallapop-connect/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200"],"pointer":"/webhooks","href":"webhooks/findmywebhooks","openApiOperationId":"findMyWebhooks","summary":"Retrieve webhooks"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://connect.wallapop.com","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The list of webhooks was successfully retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_16"}},"schemaId":"schema_16"}],"pointer":"/paths/~1webhooks/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_16","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_16"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/findmywebhooks"}],"panels":[]}]},"httpPath":"/webhooks"},{"label":"Update a webhook","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/webhooks/webhooks/updatewebhook","routeSlug":"/apis/webhooks/webhooks/updatewebhook","metadata":{"seo":{"title":"Update a webhook","description":"You can modify the webhook definition by updating the endpoint url and the list of events to which the webhook is subscribed."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateWebhook","name":"Update a webhook","isWebhook":false,"pointer":"/paths/~1webhooks~1{webhookId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a webhook","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can modify the webhook definition by updating the endpoint "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the list of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"events"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to which the webhook is subscribed."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuthWithPKCE","scopes":[],"type":"oauth2","description":"The Webhooks Connect API utilizes the OAuth 2.0 Authorization Code flow with Proof Key for Code Exchange (PKCE) for secure authentication and token exchange.","flows":{"authorizationCode":{"authorizationUrl":"https://iam.wallapop.com/realms/wallapop-connect/protocol/openid-connect/auth","tokenUrl":"https://iam.wallapop.com/realms/wallapop-connect/protocol/openid-connect/token","refreshUrl":"https://iam.wallapop.com/realms/wallapop-connect/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"webhookId","in":"path","schemaId":"schema_17","description":"The webhook ID.","required":true}],"pointer":"/paths/~1webhooks~1{webhookId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WebhookRequest"}},"schemaId":"components/schemas/WebhookRequest","pointer":"/paths/~1webhooks~1{webhookId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/webhooks/{webhookId}","servers":[{"url":"https://connect.wallapop.com","description":"Production"}],"parameters":{"path":[{"name":"webhookId","in":"path","required":true,"example":"5d5ae7a4-2d0d-4be1-a5da-b49e3291e5cd","schemaId":"components/schemas/WebhookIdPathParameter"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuthWithPKCE","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://iam.wallapop.com/realms/wallapop-connect/protocol/openid-connect/auth","tokenUrl":"https://iam.wallapop.com/realms/wallapop-connect/protocol/openid-connect/token","refreshUrl":"https://iam.wallapop.com/realms/wallapop-connect/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/WebhookRequest"}},"responseCodes":["204","400","403","404"],"pointer":"/webhooks/{webhookId}","href":"webhooks/updatewebhook","openApiOperationId":"updateWebhook","summary":"Update a webhook"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://connect.wallapop.com","description":"Production"}],"schemaId":"components/schemas/WebhookRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WebhookRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"The webhook was successfully updated. There is no content to display."},{"code":"400","description":"Bad request. The server cannot process the request due to client-side issues, such as malformed syntax or invalid parameters.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Forbidden. The user does not have permission to access the requested resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Not found. A resource with the specified ID does not exist."}],"pointer":"/paths/~1webhooks~1{webhookId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/updatewebhook"}],"panels":[]}]},"httpPath":"/webhooks/{webhookId}"},{"label":"Delete a webhook","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/webhooks/webhooks/deletewebhook","routeSlug":"/apis/webhooks/webhooks/deletewebhook","metadata":{"seo":{"title":"Delete a webhook","description":"Delete a webhook by providing its id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteWebhook","name":"Delete a webhook","isWebhook":false,"pointer":"/paths/~1webhooks~1{webhookId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a webhook","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delete a webhook by providing its "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuthWithPKCE","scopes":[],"type":"oauth2","description":"The Webhooks Connect API utilizes the OAuth 2.0 Authorization Code flow with Proof Key for Code Exchange (PKCE) for secure authentication and token exchange.","flows":{"authorizationCode":{"authorizationUrl":"https://iam.wallapop.com/realms/wallapop-connect/protocol/openid-connect/auth","tokenUrl":"https://iam.wallapop.com/realms/wallapop-connect/protocol/openid-connect/token","refreshUrl":"https://iam.wallapop.com/realms/wallapop-connect/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"webhookId","in":"path","schemaId":"schema_17","description":"The webhook ID.","required":true}],"pointer":"/paths/~1webhooks~1{webhookId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/webhooks/{webhookId}","servers":[{"url":"https://connect.wallapop.com","description":"Production"}],"parameters":{"path":[{"name":"webhookId","in":"path","required":true,"example":"5d5ae7a4-2d0d-4be1-a5da-b49e3291e5cd","schemaId":"components/schemas/WebhookIdPathParameter"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuthWithPKCE","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://iam.wallapop.com/realms/wallapop-connect/protocol/openid-connect/auth","tokenUrl":"https://iam.wallapop.com/realms/wallapop-connect/protocol/openid-connect/token","refreshUrl":"https://iam.wallapop.com/realms/wallapop-connect/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["204","403","404"],"pointer":"/webhooks/{webhookId}","href":"webhooks/deletewebhook","openApiOperationId":"deleteWebhook","summary":"Delete a webhook"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://connect.wallapop.com","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"The webhook was deleted successfully."},{"code":"403","description":"Forbidden. The user does not have permission to access the requested resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Not found. A resource with the specified ID does not exist."}],"pointer":"/paths/~1webhooks~1{webhookId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/deletewebhook"}],"panels":[]}]},"httpPath":"/webhooks/{webhookId}"},{"label":"Update a webhook token","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/webhooks/webhooks/updatewebhooktoken","routeSlug":"/apis/webhooks/webhooks/updatewebhooktoken","metadata":{"seo":{"title":"Update a webhook token","description":"Update the webhook signing token to enhance security."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateWebhookToken","name":"Update a webhook token","isWebhook":false,"pointer":"/paths/~1webhooks~1{webhookId}~1token/patch","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a webhook token","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update the webhook signing token to enhance security."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oAuthWithPKCE","scopes":[],"type":"oauth2","description":"The Webhooks Connect API utilizes the OAuth 2.0 Authorization Code flow with Proof Key for Code Exchange (PKCE) for secure authentication and token exchange.","flows":{"authorizationCode":{"authorizationUrl":"https://iam.wallapop.com/realms/wallapop-connect/protocol/openid-connect/auth","tokenUrl":"https://iam.wallapop.com/realms/wallapop-connect/protocol/openid-connect/token","refreshUrl":"https://iam.wallapop.com/realms/wallapop-connect/protocol/openid-connect/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"webhookId","in":"path","schemaId":"schema_17","description":"The webhook ID.","required":true}],"pointer":"/paths/~1webhooks~1{webhookId}~1token/patch/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/webhooks/{webhookId}/token","servers":[{"url":"https://connect.wallapop.com","description":"Production"}],"parameters":{"path":[{"name":"webhookId","in":"path","required":true,"example":"5d5ae7a4-2d0d-4be1-a5da-b49e3291e5cd","schemaId":"components/schemas/WebhookIdPathParameter"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oAuthWithPKCE","type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://iam.wallapop.com/realms/wallapop-connect/protocol/openid-connect/auth","tokenUrl":"https://iam.wallapop.com/realms/wallapop-connect/protocol/openid-connect/token","refreshUrl":"https://iam.wallapop.com/realms/wallapop-connect/protocol/openid-connect/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","403","404"],"pointer":"/webhooks/{webhookId}/token","href":"webhooks/updatewebhooktoken","openApiOperationId":"updateWebhookToken","summary":"Update a webhook token"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://connect.wallapop.com","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The webhook token was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookTokenUpdatedResponse"}},"schemaId":"components/schemas/WebhookTokenUpdatedResponse"},{"code":"403","description":"Forbidden. The user does not have permission to access the requested resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Not found. A resource with the specified ID does not exist."}],"pointer":"/paths/~1webhooks~1{webhookId}~1token/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/WebhookTokenUpdatedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookTokenUpdatedResponse"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/updatewebhooktoken"}],"panels":[]}]},"httpPath":"/webhooks/{webhookId}/token"}],"content":{"contentType":"group","meta":{"name":"Webhooks"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Webhooks","showPageActions":true},{"nodeType":"markdoc","content":"Webhooks allow you to receive event notifications."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/webhooks","summary":"Create a new webhook","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/createwebhook","deprecated":false},{"title":"/webhooks","summary":"Retrieve webhooks","prefix":{"name":"get","color":"get"},"badges":[],"link":"/webhooks/findmywebhooks","deprecated":false},{"title":"/webhooks/{webhookId}","summary":"Update a webhook","prefix":{"name":"put","color":"put"},"badges":[],"link":"/webhooks/updatewebhook","deprecated":false},{"title":"/webhooks/{webhookId}","summary":"Delete a webhook","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/webhooks/deletewebhook","deprecated":false},{"title":"/webhooks/{webhookId}/token","summary":"Update a webhook token","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/webhooks/updatewebhooktoken","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/Error":{"id":"components/schemas/Error","kind":"json-schema","title":"Error","data":{"type":"object","required":["code","message"],"description":"Detailed information about the error encountered.","properties":{"code":{"type":"string","enum":["INVALID_BODY_REQUEST","USER_UNAUTHORIZED"],"description":"A standardized error descriptor.","example":"INVALID_BODY_REQUEST"},"message":{"description":"A detailed error message.","type":"string"}}}},"components/schemas/EventType":{"id":"components/schemas/EventType","kind":"json-schema","title":"EventType","data":{"type":"string","description":"Item events that can be subscribed to via webhooks. These events trigger notifications to the webhook when they occur.\n","enum":["SALE_COMPLETED","ITEM_BANNED","ITEM_OUT_OF_STOCK","ITEM_INACTIVATED","ITEM_LISTED","ITEM_RETURNED","DELIVERY_REQUEST_STARTED","DELIVERY_REQUEST_CANCELLED","DELIVERY_REQUEST_FAILED","DELIVERY_REQUEST_EXPIRED","TRANSACTION_CREATED","DISPUTE_CREATED","DISPUTE_QUALITY_CHECK_STARTED","DISPUTE_QUALITY_CHECK_EXPIRED","DISPUTE_QUALITY_CHECK_APPROVED_BY_SELLER","DISPUTE_ISSUE_REPORTED_BY_SELLER","DISPUTE_CANCELLED_BY_WALLAPOP","CHAT_LEAD_CREATED"],"example":"SALE_COMPLETED"}},"components/schemas/WebhookUrl":{"id":"components/schemas/WebhookUrl","kind":"json-schema","title":"WebhookUrl","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The URL where webhook notifications will be sent. This endpoint must accept POST requests and handle incoming event notifications securely. It should validate HMAC signatures, return a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2xx"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" HTTP status code upon successful receipt, and process event payloads accordingly."},"children":[]}]}]}]}},"components/schemas/WebhookToken":{"id":"components/schemas/WebhookToken","kind":"json-schema","title":"WebhookToken","data":{"type":"string","description":"A secure HMAC token linked to the webhook, used to sign requests sent to the webhook URL. This token must be used to verify the authenticity and integrity of incoming webhook requests.\n","example":"KVXQK63TysQsPgjUQiA8nEVN9Og5bGm5AnFGdecuOks175l894ogW3qFsfAQYIfq"}},"components/schemas/WebhookIdPathParameter":{"id":"components/schemas/WebhookIdPathParameter","kind":"json-schema","title":"WebhookIdPathParameter","data":{"type":"string","description":"The ID of the webhook.","example":"5d5ae7a4-2d0d-4be1-a5da-b49e3291e5cd"}},"components/schemas/WebhookRequest":{"id":"components/schemas/WebhookRequest","kind":"json-schema","title":"WebhookRequest","data":{"type":"object","required":["url","events"],"properties":{"url":{"$ref":"#/components/schemas/WebhookUrl"},"events":{"type":"array","items":{"$ref":"#/components/schemas/EventType"}}}}},"components/schemas/CreateWebhookResponse":{"id":"components/schemas/CreateWebhookResponse","kind":"json-schema","title":"CreateWebhookResponse","data":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the newly created webhook."},"token":{"$ref":"#/components/schemas/WebhookToken"}}}},"components/schemas/WebhookTokenUpdatedResponse":{"id":"components/schemas/WebhookTokenUpdatedResponse","kind":"json-schema","title":"WebhookTokenUpdatedResponse","data":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the updated webhook."},"token":{"$ref":"#/components/schemas/WebhookToken"}}}},"components/schemas/FindWebhookResponse":{"id":"components/schemas/FindWebhookResponse","kind":"json-schema","title":"FindWebhookResponse","data":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the webhook.","example":"a1234b567c890"},"url":{"$ref":"#/components/schemas/WebhookUrl"},"token":{"$ref":"#/components/schemas/WebhookToken"},"events":{"type":"array","items":{"$ref":"#/components/schemas/EventType"}}}}},"schema_16":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/FindWebhookResponse"}},"id":"schema_16"},"schema_17":{"kind":"json-schema","data":{"$ref":"#/components/schemas/WebhookIdPathParameter"},"id":"schema_17"}},"exampleStore":{},"securitySchemeStore":{"oAuthWithPKCE":{"id":"oAuthWithPKCE","type":"oauth2","description":"The Webhooks Connect API utilizes the OAuth 2.0 Authorization Code flow with Proof Key for Code Exchange (PKCE) for secure authentication and token exchange.","flows":{"authorizationCode":{"authorizationUrl":"https://iam.wallapop.com/realms/wallapop-connect/protocol/openid-connect/auth","tokenUrl":"https://iam.wallapop.com/realms/wallapop-connect/protocol/openid-connect/token","refreshUrl":"https://iam.wallapop.com/realms/wallapop-connect/protocol/openid-connect/token","scopes":{}}}}},"servers":[{"url":"https://connect.wallapop.com","description":"Production"}],"specType":"openapi"},"options":{"showExtensions":true,"jsonSamplesExpandLevel":5,"codeSamples":{"skipOptionalParameters":true,"languages":[{"lang":"curl","label":"cURL"}]},"feedback":{"type":"mood","settings":{"comment":{"satisfiedLabel":"What did you like most about this page?","dissatisfiedLabel":"What didn't you like about this page?","neutralLabel":"What could we improve on this page?"},"label":"Was this section helpful?"}},"mockServer":{"url":"/_mock/apis/webhooks","position":"off","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/apis/webhooks.json?download"},{"url":"/_bundle/apis/webhooks.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Webhooks Connect API","description":"API for managing webhooks to subscribe to specific events related to items in Wallapop.\n"}},"baseSlug":"/apis/webhooks","routesMapping":{}}