{ "opencollection": "1.0.0", "info": { "name": "Core accepted countries Webhooks API", "version": "3.0.39" }, "request": { "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "items": [ { "info": { "name": "Webhooks", "type": "folder" }, "items": [ { "info": { "name": "List webhooks", "type": "http" }, "http": { "method": "GET", "url": "/v3/webhooks", "params": [ { "name": "active", "value": "", "type": "query", "description": "Set to `true` to return only active webhook configurations, otherwise all webhook configurations will be returned." }, { "name": "count", "value": "", "type": "query", "description": "Number of resources to retrieve." }, { "name": "start_index", "value": "", "type": "query", "description": "Sort order index of the first resource in the returned array." }, { "name": "fields", "value": "", "type": "query", "description": "Comma-delimited list of fields to return (`field_1,field_2`, and so on).\nLeave blank to return all fields." }, { "name": "sort_by", "value": "", "type": "query", "description": "Field on which to sort.\nUse any field in the resource model, or one of the system fields `lastModifiedTime` or `createdTime`.\nPrefix the field name with a hyphen (`-`) to sort in descending order.\nOmit the hyphen to sort in ascending order." } ] }, "docs": "Returns an array of all webhooks.\n\nThis endpoint supports <>, <>, and <>.\n\n[NOTE]\nAs shown in the example, `config.secret`, `config.basic_auth_username`, and `config.basic_auth_password` are masked in responses to this and all other requests.\nTo ensure you can access these values as needed, update them on your endpoint, store them securely, and then <>." }, { "info": { "name": "Update webhook", "type": "http" }, "http": { "method": "PUT", "url": "/v3/webhooks/:token", "params": [ { "name": "token", "value": "", "type": "path", "description": "Unique identifier of the webhook." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a webhook.\n\nYou can also use this endpoint to disable webhooks you no longer want to receive—there is no `DELETE` method available to remove unneeded webhooks.\nTo disable a webhook, use this endpoint to set its `active` field to `false`.\n\n[NOTE]\nAs shown in the example, `config.secret`, `config.basic_auth_username`, and `config.basic_auth_password` are masked in responses to this and all other requests.\nTo access these values later, store them securely before making the request.\nWhen mod" }, { "info": { "name": "Ping webhook", "type": "http" }, "http": { "method": "POST", "url": "/v3/webhooks/:token/ping", "params": [ { "name": "token", "value": "", "type": "path", "description": "Unique identifier of the webhook." } ] }, "docs": "Pings your webhook endpoint.\n\nSend a ping request to your webhook endpoint to validate credentials and connectivity.\nYour webhook endpoint must be configured to respond.\n\n=== Configuring your webhook endpoint\n\nWhen the Marqeta platform receives the ping request, it sends a `POST` request containing the following body to the URL of your webhook endpoint:\n\n[#ping-webhook-sample]\n[source,json]\n----\n{\n \"pings\": [\n {\n \"token\": \"marqeta\",\n \"payload\": \"healthcheck\"\n }\n ]\n}\n----\n\nTo in" }, { "info": { "name": "Resend event notification", "type": "http" }, "http": { "method": "POST", "url": "/v3/webhooks/:token/:event_type/:event_token", "params": [ { "name": "token", "value": "", "type": "path", "description": "Unique identifier of the webhook." }, { "name": "event_type", "value": "", "type": "path", "description": "Specifies the type of event you want to resend." }, { "name": "event_token", "value": "", "type": "path", "description": "Unique identifier of the event for which you want to resend a notification." } ] }, "docs": "Resends an event notification to your webhook endpoint.\n\nAlthough you send this request as a `POST`, all parameters are passed in the URL and the body is empty.\nThe event notification is resent to your webhook endpoint and is also returned in the response to this request." } ] } ], "bundled": true }