Replace the events of a webhook destination

POST /v1/webhook_destinations/{id}

Replace the events of a webhook destination

POST/v1/webhook_destinations/{id}

Autenticação

Chave secretask_…, só no seu servidor

Envie a chave no cabeçalho Authorization: Bearer <chave>.

Parâmetros

idstring · pathobrigatório

Corpo da requisição

eventsarray of stringobrigatório
Valores: checkoutsubscription_cyclesubscription

Resposta

200OK

idstringpode ser nullobrigatório
`null` for a destination managed by Paystation.
urlstringpode ser nullobrigatório
`null` for a destination managed by Paystation.
originstringpode ser nullobrigatório
eventsarray of stringobrigatório
Valores: checkoutsubscription_cyclesubscription
managed_bystringobrigatório
Valores: partnerpaystation

Erros

400	The request path could not be decoded (`malformed_path`).
401	Missing or invalid key, or a public key (`secret_key_required`).
404	No such destination (`destination_not_found`).
409	Checkout is still configured by Paystation (`legacy_configuration_active`).
422	The body is invalid.
429	Rate limited.
500	Unexpected error, or `api_unavailable`.

Todo erro vem no mesmo envelope: error.type, error.code, error.message e error.request_id, também devolvido no cabeçalho X-Request-Id.

Request

cURLNode

bash

curl -X POST "https://paystation-homolog.quero.space/v1/webhook_destinations/{id}" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer sk_test_…" \
  -d '{
    "events": [
      "checkout"
    ]
  }'

const response = await fetch(`https://paystation-homolog.quero.space/v1/webhook_destinations/${id}`, {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    Authorization: `Bearer ${process.env.PAYSTATION_KEY}`,
  },
  body: JSON.stringify({
    "events": [
      "checkout"
    ]
  }),
})
const body = await response.json()

Response

json

{
  "id": "string",
  "url": "string",
  "origin": "string",
  "events": [
    "checkout"
  ],
  "managed_by": "partner"
}

json

{
  "error": {
    "type": "invalid_request_error",
    "code": "string",
    "message": "string",
    "param": "string",
    "resource_id": "string",
    "request_id": "string"
  }
}

json

{
  "error": {
    "type": "invalid_request_error",
    "code": "string",
    "message": "string",
    "param": "string",
    "resource_id": "string",
    "request_id": "string"
  }
}

json

{
  "error": {
    "type": "invalid_request_error",
    "code": "string",
    "message": "string",
    "param": "string",
    "resource_id": "string",
    "request_id": "string"
  }
}

json

{
  "error": {
    "type": "invalid_request_error",
    "code": "string",
    "message": "string",
    "param": "string",
    "resource_id": "string",
    "request_id": "string"
  }
}

json

{
  "error": {
    "type": "invalid_request_error",
    "code": "string",
    "message": "string",
    "param": "string",
    "resource_id": "string",
    "request_id": "string"
  }
}

json

{
  "error": {
    "type": "invalid_request_error",
    "code": "string",
    "message": "string",
    "param": "string",
    "resource_id": "string",
    "request_id": "string"
  }
}

json

{
  "error": {
    "type": "invalid_request_error",
    "code": "string",
    "message": "string",
    "param": "string",
    "resource_id": "string",
    "request_id": "string"
  }
}

Replace the events of a webhook destination ​

Replace the events of a webhook destination

Autenticação

Parâmetros

Corpo da requisição

Resposta

Erros

Replace the events of a webhook destination