logo

Create a webhook credential

Creates a webhook credential.

SecuritySecretApiKey or JWT
Request
Request Body schema: application/json

Credential resource.

host
required
string

Name of the host.

status
string

Status of the credential.

Enum: Description
active

Credential is active and can be used.

inactive

Credential is temporarily inactivated and cannot be used until reactivated.

deactivated

Credential is permanently deactivated and cannot be reactivated.

object (WebhookAuthorization)

Authentication type and details.

type
required
string
Default: "none"

Type of authorization.

Responses
201

Webhook credential created.

Response Headers
Location
string <uri>

Location of the related resource.

Example: "https://api.rebilly.com/example"
Response Schema: application/json
host
required
string

Name of the host.

hash
string <= 50 characters

Unique resource ID. Defaults to UUID v4.

status
string

Status of the credential.

Enum: Description
active

Credential is active and can be used.

inactive

Credential is temporarily inactivated and cannot be used until reactivated.

deactivated

Credential is permanently deactivated and cannot be reactivated.

deactivationTime
string <date-time>

Date and time when the credential is deactivated.

object (WebhookAuthorization)

Authentication type and details.

type
required
string
Default: "none"

Type of authorization.

303

Existing webhook credential retrieved.

401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

422

Invalid data sent.

post/credential-hashes/webhooks
Request samples
application/json
{
  • "status": "active",
  • "host": "string",
  • "auth": {
    }
}
Response samples
application/json
{
  • "hash": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "status": "active",
  • "deactivationTime": "2019-08-24T14:15:22Z",
  • "host": "string",
  • "auth": {
    }
}
➔ Next to Retrieve a webhook credential