Webhook keys

Get Webhook Key

get/webhook_keys/{id}

Request

Path parameters

idstring required
Example:6307a60c41de27127515a575

Identifier of the resource

Headers

Accept-Language'es' | 'en'

Use for knowing which language to use

X-Child-Company-Idstring

In the case of a holding company, the company id of the child company to which will process the request.

Response

successful

idstring

Unique identifier of the webhook key

activeboolean

Indicates if the webhook key is active

created_atinteger

Unix timestamp in seconds with the creation date of the webhook key

deactivated_atinteger nullable

Unix timestamp in seconds with the deactivation date of the webhook key

public_keystring

Public key to be used in the webhook

livemodeboolean

Indicates if the webhook key is in live mode

objectstring

Object name, value is webhook_key

Example response

{
  "id": "62730ba6fb7dfd6a712f118e",
  "active": true,
  "created_at": 1577836800,
  "public_key": "-----BEGIN PUBLIC KEY-----\\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAqULpUc6D6mSAq5a0yLY/\\noOjd1mWm6q+QI8y/FI4STr2F+XgKeNnMxSqnyFrHtKQ/ut4Zi45WFnJLfEQL7aW5\\n67yE2dWyo6GaL7yZUfLC0Y3sHPGzaGtvDF36ISW7LliYNoMiA3Bx5/1Sr0G23pGW\\n0Mp8IO1Nlz0sJWuU/d7zCz/UN6cl9g/BP4eaQ7deS56YuWcj5sTlwqFTlwN12kpA\\nIzMZ7gnvYQnZTpPny5lben6QEuxTvZcPApcyOweiESjMnXfkfWOyuYtgMrbsU6oL\\nA6sWa6j0pePW7AYeBqB4tyAlenkCSqzHg8bMk5Bm7hiT6I9Pls774lJbnOYmmuNE\\n8QIDAQAB\\n-----END PUBLIC KEY-----\\n",
  "object": "webhook_key"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.