Add a webhook endpoint

POST

/api/v1/webhooks

curl --request POST \
  --url https://digize.com/api/v1/webhooks \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: 5f1c2a8e-3b7d-4c55-9a0e-1f2d3c4b5a69' \
  --header 'x-api-key: <x-api-key>' \
  --data '{ "url": "https://hooks.northloop.example/digize", "events": [ "crm.contact.created", "commerce.order.paid" ], "description": "Our order system" }'

• Digize

Adds an HTTPS endpoint that gets the events named, or * for every event. The signing secret comes back once.

Needs the settings:write permission.

Authorizations

• apiKey
• bearer

Parameters

Header Parameters

Idempotency-Key

string

>= 1 characters <= 255 characters

Makes the request safe to send again: for 24 hours the same key and request answer the first response without repeating the change.

Example

5f1c2a8e-3b7d-4c55-9a0e-1f2d3c4b5a69

Request Body^required

Media typeapplication/json

object

url

required

An https:// address on the public internet.

string format: uri

events

required

Array

>= 1 items <= 50 items

description

string

<= 200 characters

Example

{
  "url": "https://hooks.northloop.example/digize",
  "events": [
    "crm.contact.created",
    "commerce.order.paid"
  ],
  "description": "Our order system"
}

Responses

201

Done

Media typeapplication/json

object

id

required

string

url

required

string

events

required

Array<string>

description

required

string | null

source

required

zapier for a REST hook subscription made through /hooks.

string

Allowed values: api zapier

createdBy

required

string

createdAt

required

string format: date-time

disabledAt

required

Any of:

string

string format: date-time

null

null

failures

required

Attempts that failed since the last one that got through.

integer

<= 9007199254740991

lastDeliveryAt

required

Any of:

string

string format: date-time

null

null

secret

required

Signs every delivery’s Digize-Signature header. Shown only now.

string

Example

{
  "source": "api"
}

400

What was sent isn’t valid (invalid).

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

401

No key, or one that’s unknown, off or expired.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

403

The key doesn’t have the permission this needs.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

404

Nothing has that id (not_found).

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

409

A request with the same Idempotency-Key is still running (conflict).

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

422

The Idempotency-Key was used with a different request.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

429

Over the rate limit; see retry-after.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}